---
title: "Get Countries"
method: GET
path: "/v4/countries"
tags: ["Reference Data"]
---

# Get Countries

`GET /v4/countries`

Retrieves a list of countries available on the system along with their relevant details. 
<br />With this endpoint, you can search for specific countries, paginate results, and sort the data as needed.

## Query parameters

- `searchTerm` string
- `pageSize` integer
- `pageNumber` integer
- `sortBy` 'CountryName' | 'Alpha2Code' | 'Alpha3Code' | 'Numeric' | 'CountryGroup' | 'PostcodeRequired' | 'StateCodeRequired' | 'DefaultCurrency' — Sort By
- `sortDir` 'Ascending' | 'Descending' — Order Direction

## Response `200`

Returns a list of countries.

- CountriesPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `Countries` Country[], required — An array containing the individual country records retrieved by the API. <br />Each record includes detailed information about a specific country.
    - `CountryName` string, required — The official name of the country. <br />This field is crucial for identifying countries within the response.
    - `Alpha2Code` string, required — A two-letter country code (ISO 3166-1 alpha-2) that uniquely identifies the country. <br />This code is widely used in various international standards and systems.
    - `Alpha3Code` string, required — A three-letter country code (ISO 3166-1 alpha-3) that provides a separate unique identifier for the country. <br />This code can be useful for more detailed country representation.
    - `Numeric` string, required — A numeric code (ISO 3166-1 numeric) assigned to each country. <br />This code is utilised in the system for identifying the countries numerically.
    - `CountryGroup` 'ROW' | 'EU', required — Indicates the grouping of the country, such as "ROW" (Rest of World) or "EU" (European Union). <br />This categorisation is essential for understanding trade, regulatory, or geopolitical contexts.
    - `PostcodeRequired` boolean, required — A boolean value indicating whether a postal code is required for the country. <br />This field helps determine whether address validation includes postal code checks.
    - `StateCodeRequired` boolean, required — A boolean value indicating whether state or province codes are required for the country. <br />This is particularly relevant for countries with sub-national divisions.
    - `DefaultCurrency` string, required — The currency used as the standard in the country. <br />This field provides clarity on monetary transactions and conversions.
  - `TotalCount` integer, required — An integer representing the total number of countries matching the search criteria, regardless of pagination. <br />This information is useful for understanding the full scope of available results.

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)