Filter countries.

GET /countries

Sample request:

GET /countries?code=FR&offset=0&limit=5

or

GET /countries?code=AD,FR&offset=0&limit=5

If you want to search for multiple values for a given parameter, enter :

param=val1,val2

For example, the query shown above would return the countries that have a code being either AD or FR.

Query parameters

code string

Country code to search for.

Default value is empty.
name string

Country name to search for.

Default value is empty.
identifier string

Country identifier to search for.

Default value is empty.
desc boolean

Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.

Default value is false.
offset integer(int32)

Index of the first returned result.

Default value is 0.
limit integer(int32)

Number of results to be returned. Max value is 10.

Default value is 10.

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- total integer(int32)
  
  Total number of items found by the query
- first integer(int32)
  
  Index of the first returned object
- items array[object] | null
  
  Countries which are based on ISO 3166 standard.
  
  Countries which are based on ISO 3166 standard.
  
  Hide items attributes Show items attributes object
  
  name string | null
  
  Name of country
  
  Minimum length is 0, maximum length is 256.
  
  alphaCode2 string | null
  
  Two letter code of country
  
  Minimum length is 0, maximum length is 2.
  
  alphaCode3 string | null
  
  Three letter code of country
  
  Minimum length is 0, maximum length is 3.
  
  identifier integer(int32)
  
  Digital code of country
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
400 application/json

Unexpected error
Hide response attributes Show response attributes object
- status string | null
  
  Error status
- timestamp string(date-time)
  
  Error date
- code string | null
  
  Error code
  - R101 : The container size type is unfound.
  - R102 : The country code is unfound.
  - R103 : The document type is unfound.
  - R104 : The location code is unfound.
  - R105 : The location type is unfound.
  - R106 : The packaging code is unfound.
  - R107 : The transport mode is unfound.
  - R108 : The transport mean type is unfound.
  - R109 : The event type is unfound.
  - R110 : The UN/LOCODE is unfound.
  - R111 : The actor is unfound.
  - R112 : The dangerous code is unfound.
- message string | null
  
  Error message
- Additional properties are NOT allowed

GET /countries

curl \
 -X GET https://soget-api-integration.azure-api.net/api-referential-list/v1/countries \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Ocp-Apim-Subscription-Key: $API_KEY"

Response examples (200)

{
  "total": 11,
  "first": 3,
  "items": [
    {
      "name": "France",
      "alphaCode2": "FR",
      "alphaCode3": "FRA",
      "identifier": 250
    }
  ]
}

Response examples (400)

{
  "status": "400",
  "timestamp": "2022-10-18T14:53:52.239Z",
  "code": "R001",
  "message": "Information not found."
}