Skip to main content

Retrieve Country

Retrieves the details of a specific country by its ID.

HTTP Request

GET/api/locations/countries/:id

Authorization

Authorization

  • Required: Yes
  • Permission: Admin or Staff
  • Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters

ParameterTypeRequiredDescription
idIntegerYesUnique ID of the country

Example Requests

1import requests
2
3response = requests.get('http://www.example.com/api/locations/countries/1', 
4  headers={'Authorization': 'Token <your_api_key>'}
5)
6print(response.json())

Status Codes

CodeDescription
200Country retrieved successfully
400Bad request — invalid input
404Country not found
500Internal server error

Response Fields

FieldTypeDescription
idIntegerUnique ID of the country
nameStringName of the country
codeStringISO code of the country (e.g., "IR")