Countries

Get county by ID

Retrieve detailed information for a specific county/municipality within a state and country

get/api/v1/countries/{countrySymbol}/states/{stateId}/counties/{countyId}

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/countries/{countrySymbol}/states/{stateId}/counties/{countyId}
  • Auth: none declared

Path parameters

countrySymbolstring required
Example:MX

Country symbol (ISO 3166-1 alpha-2 code, e.g., 'MX', 'US', 'CA')

stateIdstring required
Example:1

State identifier (e.g., '1', '25')

countyIdstring required
Example:cnt_456

County identifier (e.g., 'cnt_456', 'cnt_789')

Response

Get county by ID

idstring required
namestring required
stateIdstring required
codestring required
billingIdnumber required

Example response

{
  "id": "cnty_b99a52f0-dd5e-4659-953f-15a1db623afd",
  "State": {
    "id": "st_8289dc19-e775-4c0c-a42a-e0da129e3b64",
    "name": "Aguascalientes",
    "code": "AGU",
    "countryId": "ctry_234d985a-a899-473c-915b-04cbb67207cc",
    "billingId": 18,
    "Country": {
      "id": "ctry_8efa0d0c-f834-42eb-af78-ff4149c2e6ef",
      "Currency": {
        "currency": "ARS",
        "currencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.