Skip to main content

List Areas

POST 
/area/list

Lists areas visible to the current user. Pass version: 2 (CLI: --version 2) to use filters, sorting, statistics, and pagination; omit version only for legacy v1 behavior. Set size to limit each v2 page, then pass the returned sortTimestamp to retrieve the next page. Filter by a specific user, team, or set of downline team IDs. When no filter is provided, returns all areas the caller has permission to view — company admins and users with company-level area:add see all areas; other users see areas for their managed teams plus any unassigned areas. Requires the area:list permission. Use /area/get instead when you already have the areaId.

Request​

Responses​

Success