Townships

get

/townships/

Similar to districts, this retrieves information about townships, linked to cities in the system.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

cityintegerOptional

Query parameter city used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

limitinteger · max: 1000Optional

Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

postcodestringOptional

Query parameter postcode used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

translationsany · nullableOptional

Query parameter translations used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get/townships/

GET /api/v1/remote/1/data-warehouse/townships/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "city": 1,
      "created_date": "2026-01-01T00:00:00.000Z",
      "id": 1,
      "is_active": true,
      "modified_date": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "postcode": "text",
      "translations": null
    }
  ]
}

get

/townships/{id}/

Similar to districts, this retrieves information about townships, linked to cities in the system. This endpoint retrieves a specific record by its unique identifier.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this township.

Responses

200

Successful response for status code 200.

application/json

cityintegerOptional

This field defines the city ID associated with the township.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

idintegerOptional

Unique identifier for the record.

is_activebooleanOptional

Boolean flag indicating whether the condition is met.

modified_datestring · date-timeOptional

This field defines the last updated date.

namestring · max: 128Optional

The full name or label associated with the record.

postcodestring · max: 255 · nullableOptional

This field defines the postcode of the township.

translationsany · nullableOptional

This field defines the translations of the township name.

404

Object not found.

application/json

get/townships/{id}/

GET /api/v1/remote/1/data-warehouse/townships/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "city": 1,
  "created_date": "2026-01-01T00:00:00.000Z",
  "id": 1,
  "is_active": true,
  "modified_date": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "postcode": "text",
  "translations": null
}