Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
topOfPage
topOfPage
The Country API is used to access the different country objects available on your business' account. 


Info
titleOn this page

Table of Contents





Country API Endpoints


These are the endpoints that are available under the /country path, which lists all the different country objects that are available on your business account.

Endpoint

Description

GET /country

Returns all country objects available on your business' account in array format. 





Country API Parameters

There are no parameters included with country calls.




Country API Responses


Code Block
languagejs
titleGET /country
linenumberstrue
collapsetrue
[{
    "country": "United States",
    "countryCode": "US",
    "countryId": 1
}]





Country Object Values


Property name

Type

Description

country

string

Displays as the name of the specified country.

countryCode

string

Displays as the code used to signify the specified country.

countryId

integer

Provides unique numeric ID for the specified country.