---
title: "GET /rest/v1/locations"
method: GET
path: "/rest/v1/locations"
---

# GET /rest/v1/locations

`GET /rest/v1/locations`

Finds all locations in the company your API credentials belong to.

## Query parameters

- `ids` ID[]
- `createdAtAfter` string, date-time — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- `createdAtBefore` string, date-time — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- `enabled` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- `page` number — Integers that will have a value greater than 0.
- `perPage` number — Integers that will have a value greater than 0.
- `sort` union
  - 'createdAt'
  - 'updatedAt'
- `order` union
  - 'asc'
  - 'desc'

## Response `default`

[Location!]!

- object
  - `data` Location[], required
    - `id` string, required — The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
    - `name` string, required — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
    - `address` object
      - `line1` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
      - `line2` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
      - `city` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
      - `state` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
      - `postalCode` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
      - `country` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
      - `latitude` number — The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
      - `longitude` number — The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
    - `enabled` boolean, required — The `Boolean` scalar type represents `true` or `false`.
    - `companyId` string, required — The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
    - `locale` string, required — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
    - `logoUrl` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
    - `timezone` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
    - `capacityLimit` number — The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
    - `scheduleAheadLimit` number — The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
    - `createdAt` string, date-time, required — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
    - `updatedAt` string, date-time, required — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
  - `meta` object
    - `messages` string[] — Optional scope information.
    - `page` integer — The page of results this response represents.
    - `perPage` integer — The number of results per page.
    - `total` integer — The total number of results across all pages.

---

[API](https://skmtc.net/envoy/apis/envoy-developer-api.md) · [All operations](https://skmtc.net/envoy/apis/envoy-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/envoy/envoy-developer-api/revisions/51c85bc66c44/schema)