Skip to main content

Configuration

APIs related to Getfly's Configuration Information.

📄️ Province / City ListGet a list of provinces / cities### HTTP Request[POST] /api/v6/configs/provinces### Query Parameters#### Fields| Fields | Type | Description |:--------------|---------|:---------------|| id | integer | Identifier || province_name | string | Province name |#### Filtering| Fields | Support | Type | Description |:-----------|:--------|:-------:|:-------------------|| id | eq,in | integer | Identifier || valid | eq | integer | Valid or not || country_id | eq,in | integer | Country identifier |#### Limit & Offset| | Type | Description |:-------|---------|--------------------------|| Limit | integer | Number of records to retrieve || Offset | integer | Number of records to skip |### ExampleHTTP RequesthttpGET api/v6/configs/provinces?fields=province_name&limit=1&offset=1&filtering[country_id]=2 HTTP/1.1Host: example.getflycrm.comAuthorization: Bearer tokenStatus200 OKResponsejson{ "data": [ { "id": 2, "province_name": "Hanoi", } ], "has_more": true, "offset": 1, "limited": 1}

HTTP Request[POST] /api/v6/configs/provinces### Query Parameters#### Fields| Fields | Type | Description |---------------|| id | integer | Identifier || provincename | string | Province name |#### Filtering| Fields | Support | Type | Description |--------||-------|---------|--------------------------|| Limit | integer | Number of records to retrieve || Offset | integer | Number of records to skip |### ExampleHTTP Request`httpGET api/v6/configs/provinces?fields=provincename&limit=1&offset=1&filtering[countryid]=2 HTTP/1.1Host Bearer token`Status`200 OK`Response`json{ "data" 2, "provincename" true, "offset" 1}`