Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Locations

List locations

Endpoint used to list location resources

get/locations

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Locations returned

namestring

Will only show locations that have a name starting with this.

customFieldNamestring[]

Filter locations by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named "Industry" with the value "Construction", you would do this "/locations?Industry=Construction"). <br><br>Adding multiple instance of the same custom field act as an <code>OR</code> and adding a different custom field act as an <code>AND</code>. (ie: To filter by a custom field named <code>Industry</code> with the value <code>Construction</code> OR <code>Transportation</code> AND the custom field <code>Manufacturer</code> with the value <code>ACME</code>, you would do this <code>/locations?Industry=Construction&Industry=Transportation&Manufacturer=ACME</code>). <br><br>If your custom field label is the same as a reserved query parameter such as <code>limit</code>, <code>sort</code>, <code>expand</code>, etc, you can add <code>__c</code> to your custom field filtering (ie: To filter by a custom field named <code>limit</code> with the value <code>ten</code>, you would do this <code>/locations?limit__c=ten</code>). <br><br>Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported.

expandstring[]

To expand multiple fields: expand=extra_fields&expand=team_ids

Headers

x-organization-idinteger

Required if using a multi organizations token

x-organization-idsstring

Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other).

Response

Successfully fetched Locations list

nextCursorstring nullable required

The cursor to retrieve the next page of Locations.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Locations.

Example response

{
  "locations": [
    {
      "id": 963,
      "name": "Warehouses",
      "description": "The warehouse where we store the forklifts",
      "address": "1090 main street, Franklin",
      "parentId": 852,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "organizationId": 1,
      "externalId": "ext-location-001",
      "extraFields": {
        "Department": "Electrical"
      },
      "teamIds": [
        2
      ],
      "vendorIds": [
        2
      ],
      "barcode": "BWFPBNRHAW54CG"
    }
  ]
}