COconnecteam
Sales:Sales V1:Sales Locations

Get locations

Retrieve a list of locations associated with the account

get/sales/v1/locations

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/sales/v1/locations
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: sales_data.read

Query parameters

locationIdsinteger[]

List of location IDs to filter by

locationNamesstring[]

List of location names to filter by

isActiveboolean

Filter by active status

limitinteger

The maximum number of results to display per page

offsetinteger

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

Response

Successful Response

requestIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.