Locations

Returns a paginated list of physical locations configured in the platform

Returns a paginated list of physical locations configured in the platform.

GEThttps://example.thoughtindustries.com/incoming/v2/locations

Example request

curl "https://example.thoughtindustries.com/incoming/v2/locations" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`cursor`	`string`	No	query	Opaque pagination cursor returned by a previous response; use to fetch the next page of results.

Example response

{
  "pageInfo": {
    "total": 0,
    "cursor": "string",
    "hasMore": true
  },
  "locations": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "room": "string",
      "address1": "string",
      "address2": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string",
      "country": "string",
      "timeZone": "string"
    }
  ]
}

Response fields

Field	Type	Description
`pageInfo`	`CursorPageInfo`	Pagination metadata for the current result set.
`pageInfo.total`	`integer`	Total number of locations across all pages.
`pageInfo.cursor`	`string`	Opaque cursor to pass in the next request to retrieve the following page.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results are available.
`locations`	`Location[]`	Array of location objects returned for the current page.
`locations.id`	`uuid`	Unique identifier for the location.
`locations.name`	`string`	Display name of the location.
`locations.room`	`string`	Room or suite designation within the location.
`locations.address1`	`string`	Primary street address line.
`locations.address2`	`string`	Secondary address line (e.g., suite or floor number).
`locations.city`	`string`	City where the location resides.
`locations.state`	`string`	State or province where the location resides.
`locations.zipCode`	`string`	Postal or ZIP code for the location.
`locations.country`	`string`	Country where the location resides.
`locations.timeZone`	`string`	IANA time zone identifier for the location (e.g., `America/New_York`).