District List

Get a list of districts

HTTP Request

[POST] /api/v6/configs/districts

Query Parameters

Fields

Fields	Type	Description
id	integer	Identifier
district_name	string	District name

Filtering

Fields	Support	Type	Description
id	eq,in	integer	Identifier
valid	eq	integer	Valid or not
province_id	eq,in	integer	Province identifier

Limit & Offset

	Type	Description
Limit	integer	Number of records to retrieve
Offset	integer	Number of records to skip

Example

HTTP Request

GET api/v6/configs/districts?fields=district_name&limit=1&offset=1&filtering[province_id]=2 HTTP/1.1
Host: example.getflycrm.com
Authorization: Bearer token

Status

200 OK

Response

{
  "data": [
    {
      "id": 2,
      "district_name": "Ba Dinh District"
    }
  ],
  "has_more": true,
  "offset": 1,
  "limited": 1
}