Get Countries

Returns the list of countries the platform supports, each with the global_country_id used when creating or updating a location.

Request Headers

HeaderRequiredDescription
AuthorizationYesBearer YOUR_ACCESS_TOKEN

Request Parameters

This endpoint takes no path, query, or body parameters.

cURL Example

curl --request GET \
  --url https://sandbox-api.softpoint.io/interface/v1/global/countries \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN"

Success Response

The response is an array of country objects (truncated here).

[
  { "id": 1, "name": "Afghanistan", "code": "AF" },
  { "id": 2, "name": "Albania", "code": "AL" },
  { "id": 3, "name": "United States", "code": "US" }
]

Response Fields

FieldTypeDescription
idintegerThe global_country_id to reference elsewhere.
namestringCountry name.
codestringISO country code.

Status Codes

CodeDescription
200Country list returned

Workflow Placement

A reference lookup used before Create A Location, to resolve global_country_id.

Notes

  • The list is global reference data and changes rarely; it can be cached.

Common Mistakes

  • Sending a country name instead of its id when creating a location.
Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json