Sign in
latestOpenAPI 3.1.02026-07-26294215839.4 KB

19ebf391a399

Public API

Get country by ID

Returns a single country by catalog id. Response fields match each element of GET /api/v1/meta/countries/options (id, name, isoCode and nullability).

OAuth Scopes: meta

get/api/v1/meta/countries/{id}

Path parameters

idinteger required

Country id from GET /api/v1/meta/countries/options (id on the desired row).

Response

Country resource.

idinteger

Internal country identifier. Use the same value as the countryId path parameter for Get States by Country ID (this endpoint returns JSON numbers, not stringified digits).

namestring

Full display name of the country

isoCodestring nullable

ISO 3166-1 alpha-2 when defined. The isoCode key is always present; the value is JSON null when the country has no code set in data (not omitted).