---
title: "location.list"
method: POST
path: "/location.list"
tags: ["Location"]
---

# location.list

`POST /location.list`

List all locations. Regions are not returned.

See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.

**Requires the [`organizationRead`](authentication#permissions-locationlist) permission.**

## Request body

- LocationListRequest
  - `cursor` string, nullable — The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.
  - `syncToken` string, nullable — A sync token to retrieve only locations updated since the last sync. Obtained from a previous list response.
  - `limit` number, nullable — The maximum number of locations to return per page.
  - `includeArchived` boolean, nullable — When true, includes archived items. Defaults to false.
  - `includeLocationHierarchy` boolean, nullable — If true, the response will include the location hierarchy (regions). Defaults to false.

## Response `200`

Responses from the location.list endpoint

- union
  - LocationListSuccessResponse
    - `success` true, required
    - `results` Location[], required
      - `id` string, uuid, required — The unique identifier for the location
      - `name` string, required — The name of the location
      - `externalName` string, nullable, required — An alternate candidate-facing name for this location used on job boards and in the API
      - `isArchived` boolean, required — Whether the location is archived
      - `isRemote` boolean, nullable, required — Deprecated. Use workplaceType instead.
      - `address` object, nullable, required — The address for the location
        - `postalAddress` object, required — The postal address for the location
          - `addressCountry` string — The country for the location address
          - `addressRegion` string — The region for the location address
          - `addressLocality` string — The locality for the location address
          - `postalCode` string — The postal code for the location address
          - `streetAddress` string — The street address for the location
      - `parentLocationId` string, uuid, nullable, required — The unique identifier for the parent location hierarchy, if any
      - `type` 'Location' | 'LocationHierarchy', required — The type of the location component
      - `workplaceType` 'OnSite' | 'Hybrid' | 'Remote', nullable, required — The type of workplace
      - `extraData` object, nullable, required — Structured key-value information for your own use and reference. Do not store personally identifiable information in this field.
    - `nextCursor` string — Cursor for the next page of results, if available
    - `moreDataAvailable` boolean — Whether more data is available beyond this page
    - `syncToken` string — Sync token to use for future incremental syncs. Only present on the last page.
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)