Countries

Part of the Support API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).

List countries

GET /admin/api/v1/support/countries

Retrieve a paginated list of countries with filtering and sorting

🔒 Requires a valid Bearer token.

Query parameters

Parameter	Type	Required	Description	Example
include	string	No	Comma-separated list of relationships to include. Available options: currency, states	currency
filter[id]	string	No	Comma-separated list of IDs to filter by
filter[name]	string	No	Filter by country name (partial match)
filter[code]	string	No	Filter by country code (exact match)
filter[phone_code]	string	No	Filter by phone code (partial match)
filter[currency_id]	integer	No	Filter by currency ID
sort	string	Yes	Sort field	name
page	integer	Yes	Page number	1

cURL

curl -X GET "https://your-domain.com/admin/api/v1/support/countries?include=currency&sort=name&page=1" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch("https://your-domain.com/admin/api/v1/support/countries?include=currency&sort=name&page=1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/support/countries?include=currency&sort=name&page=1', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

Python

import requests

url = "https://your-domain.com/admin/api/v1/support/countries?include=currency&sort=name&page=1"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

{
  "data": [
    {
      "id": 1,
      "name": "Andorra",
      "code": "AD",
      "phone_code": "376",
      "state_required": false,
      "zip_required": true,
      "currency_id": 125,
      "created_at": "2026-10-09T07:12:47.000000Z",
      "updated_at": "2026-10-09T07:12:47.000000Z"
    },
    {
      "id": 1,
      "name": "Andorra",
      "code": "AD",
      "phone_code": "376",
      "state_required": false,
      "zip_required": true,
      "currency_id": 125,
      "created_at": "2026-10-09T07:12:47.000000Z",
      "updated_at": "2026-10-09T07:12:47.000000Z"
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "page": null,
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "page": null,
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Error response — 401

{
  "message": "Unauthenticated."
}

---

Show country

GET /admin/api/v1/support/countries/{id}

Retrieve a specific country by its ID

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
id	integer	Yes	The country ID

Query parameters

Parameter	Type	Required	Description	Example
include	string	No	Comma-separated list of relationships to include. Available options: currency, states	currency,states

cURL

curl -X GET "https://your-domain.com/admin/api/v1/support/countries/{id}?include=currency%2Cstates" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch("https://your-domain.com/admin/api/v1/support/countries/{id}?include=currency%2Cstates", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/support/countries/{id}?include=currency%2Cstates', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

Python

import requests

url = "https://your-domain.com/admin/api/v1/support/countries/{id}?include=currency%2Cstates"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

{
  "data": {
    "id": 1,
    "name": "Andorra",
    "code": "AD",
    "phone_code": "376",
    "state_required": false,
    "zip_required": true,
    "currency_id": 125,
    "created_at": "2026-10-09T07:12:47.000000Z",
    "updated_at": "2026-10-09T07:12:47.000000Z"
  }
}

Error response — 401

{
  "message": "Unauthenticated."
}

---