Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Location

location.list

List all locations. Regions are not returned.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the organizationRead permission.

post/location.list

Request body

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

syncTokenstring nullable

A sync token to retrieve only locations updated since the last sync. Obtained from a previous list response.

limitnumber nullable

The maximum number of locations to return per page.

includeArchivedboolean nullable

When true, includes archived items. Defaults to false.

includeLocationHierarchyboolean nullable

If true, the response will include the location hierarchy (regions). Defaults to false.

Example request

{
  "cursor": "G8",
  "syncToken": "jYnEBmjzR",
  "limit": 25
}

Response

Responses from the location.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "name": "Bay Area Office",
      "externalName": "San Francisco Office",
      "isArchived": false,
      "isRemote": false,
      "address": {
        "postalAddress": {
          "addressCountry": "United States",
          "addressRegion": "California",
          "addressLocality": "San Francisco",
          "postalCode": "94108",
          "streetAddress": "49 Geary St Suite 411"
        }
      },
      "parentLocationId": null,
      "type": "Location",
      "workplaceType": "Hybrid",
      "extraData": {
        "partner_external_object_id": "12345"
      }
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}