Countries

Get states by country

Retrieve all states/provinces for a specific country using the country symbol

get/api/v1/countries/{countrySymbol}/states

Request

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

Path parameters

countrySymbolstring required
Example:MX

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

Response

Get states by country

idstring required

State ID

namestring required

State name

codestring

State code

countryIdstring required

Country ID

billingIdnumber

Billing ID

Example response

[
  {
    "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.