Get

[POST] .../v1/country/get

Returns information about existing countries in system. Retrieve country reference records for addresses, partners, firms, integrations and selection lists. The response returns paged Country records with next_offset and total and supports filters id, code, name, fullname, alfa2, alfa3 and last_update while keeping ids and search as aliases. The caller must have country select permission; missing body, denied access, invalid filters or sorting and storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for the name, fullname, alfa2 and alfa3 fields.
sort_orders Array of CountrySortOrder Optional Output data sorting.

Filterable Fields

Field Type Description
alfa2 string
alfa3 string
code string Country codes.
fullname string
id int Country IDs.
last_update int
name string

Sortable Fields

Field
Alfa2
Alfa3
Code
FullName
Id
LastUpdate
Name

Request Example

{
  "filters": [
    {
      "field": "alfa2",
      "operator": "Equal",
      "value": "UZ"
    }
  ],
  "sort_orders": [
    {
      "column": "name",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Country Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 860,
      "name": "Uzbekistan",
      "fullname": "Republic of Uzbekistan",
      "code": "860",
      "alfa2": "UZ",
      "alfa3": "UZB",
      "last_update": 1712345600
    }
  ],
  "next_offset": 0,
  "total": 1
}