Countries: GetCountries

Returns a list of countries that the API supports. This is a list of countries in which you can create an office.

You do not specify an accountId or any other parameters with this method.

Permissions

Any user with a valid access token can use this method.

Request

HTTP request

GET /v2/countries

Parameters

Parameter NameValueDescription

Responses

CodeDescriptionReference
200

Request was successful.

GlobalCountries
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

GlobalResources::GetCountries

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Country

Contains details about a supported country.

countryIdstring

The two-letter code for the country.

Example: NZ

namestring

The name of the country.

Example: New Zealand

GlobalCountries

Contains a list of supported countries.

countries[Country]

An array of country objects.

}} />