Get areas

Get a list of all your areas. Use this to see how your geographic regions are organized and assigned to your team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Supports all JSON:API query parameters including:

Filtering - filter[field]=value
(e.g., filter[team_id]=f2b5455c-a784-492e-9d81-7fab128c9863&filter[updated_at][gte]=2024-08-27T06:00:00.000Z)

Sorting - sort=field or sort=-field
(e.g., sort=-inserted_at)

Pagination - page[limit]=N&page[offset]=N&page[count]=true
(e.g., page[limit]=25&page[offset]=50)

Field Selection - fields[type]=field1,field2
(e.g., fields[team]=name,external_id)

Includes - include=relationship
Valid includes: team, profiles
(e.g., include=team)

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json