Skip to main content

Retrieve City

Retrieve a specific city by its unique identifier.

HTTP Request

GET/api/locations/cities/:id

Authorization

Authorization

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

Path Parameters

ParameterTypeRequiredDescription
idintegerYesUnique identifier of the city

Example Requests

1import requests
2
3url = "https://api.example.com/api/locations/cities/42"
4headers = {
5  "Authorization": "Token <your_api_key>"
6}
7response = requests.get(url, headers=headers)
8print(response.json())

Status Codes

CodeDescription
200Successfully retrieved city details
400Invalid city ID
401Authentication required
403Insufficient permissions
500Server error occurred

Response Fields

FieldTypeDescription
idintegerUnique city identifier
namestringCity name
codestringCity code (e.g., 'LA')
stateobjectState information

State Object Fields:

FieldTypeDescription
idintegerUnique state identifier
namestringState name
codestringState code