List countries

Overview

Get the supported countries.

Use this to populate a country picker.

No token needed.

Returns countries with their codes, sorted by name. Use a country's value as country_code in List states and List cities.

Prerequisites

• None.

Base URL

Endpoint

GET /api/v1/address/countries

Authentication

Public (no token)

• Anyone gets the same global list.

Rate limit

100 requests per minute, counted per client IP address. See Rate limits.

Request parameters

None.

Request body

None.

Request payload

None.

Response body

The payload is inside data.data: one entry per country.

Response payload

{
  "data": {
    "data": [
      {
        "label": "Australia",
        "value": "AU"
      },
      {
        "label": "Canada",
        "value": "CA"
      },
      {
        "label": "United Kingdom",
        "value": "GB"
      },
      {
        "label": "United States",
        "value": "US"
      }
    ]
  }
}

Examples

Success payload

See Response payload (shortened; the full list has every country).

Error payload

429 Too many requests

{
  "message": "Too Many Attempts."
}

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/address/countries" \
  --header 'Accept: application/json'