Get Countries

Description

This service returns a list of all available countries, which is useful for populating dropdown menus or combo boxes in a user interface.


Request

Restrictions

This service can only be called when a consumer is not logged in.

Endpoint

GET https://<server-url>/api/v4/referencedata/countries

Parameters

Parameter
Location
Description

touchpoint

Query / Header

The identifier for the touchpoint making the request. If sent as a header, the name must be Thalamus-Touchpoint.

token

Query / Header

The authentication token for the API. If sent as a header, the name must be Thalamus-Token.

activity

Query / Header

Optional. The activity to be used. If sent as a header, the name must be Thalamus-Activity.

Content-Type

Header

Specifies the content type of the request body. Must be application/json.

Full URL Example

https://<server-url>/api/v4/referencedata/countries?touchpoint=test&token=testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttest

Request Body

This request does not have a body.


Response

✅ Successful Response: 200 OK

A JSON array of country objects is returned. Each object in the array contains the following fields:

Field
Type
Description

name

String

The name of the country.

id

Number

The unique identifier for the country.

JSON

[
  {
    "name": "Argentina",
    "id": 1
  },
  {
    "name": "Brazil",
    "id": 2
  },
  {
    "name": "Germany",
    "id": 3
  }
]

Last updated

Was this helpful?