Get Organization Areas Deprecated

Deprecated

GET

/api/v5/rest/org/:organization_slug/areas

GET

/api/v5/rest/org/:organization_slug/areas

$ curl https://qa.creha.co/api/v5/rest/org/organization_slug/areas \
>      -H "Secret-Access: Secret-Access" \
>      -H "Api-Key: <apiKey>"

1 {
2   "message": "Organization areas retrieved",
3   "code": "2000",
4   "datetime": "2021-10-08T16:23:05.000000",
5   "next_cursor": "YXJyYXljb25uZWN0aW9uOjA=",
6   "has_next_page": true,
7   "total_count": 4,
8   "data": [
9     {
10       "id": 1,
11       "label": "Area 1",
12       "name": "Area 1",
13       "area_level": {
14         "id": 1,
15         "name": "Area",
16         "custom_name": "Area",
17         "level_sequence": 1
18       }
19     },
20     {
21       "id": 2,
22       "label": "Area 2",
23       "name": "Area 2",
24       "area_level": {
25         "id": 1,
26         "name": "Area",
27         "custom_name": "Area",
28         "level_sequence": 1
29       },
30       "parent_id": 1
31     }
32   ]
33 }

Return a list of all areas in the organization

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired

Query parameters

cursorstringOptional

limitintegerOptionalDefaults to 10

versionintegerOptionalDefaults to 1

Response

Successful Response

messagestring

Message of the response

codestring

Internal code of the response

datetimestring

Datetime of the API in ISO Format

next_cursorstring

Next cursor of the response

has_next_pageboolean

Describes if the paginated response has more pages

total_countinteger

Total count of the response

datalist of objectsOptional

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors