[beta] List active shops.

Returns active shops in the organization. Use a shop id from this list as the shop id accepted by the work order API. The page size is 100. Shops are ordered by name, ignoring case. shopIds returns those active shops in request order and fails the request when any id is missing. The endpoint is in beta and requires the Shops read scope. It is available only when shop-concept-enabled is on for the organization.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Shops under the Work Orders category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
shopIds
array of strings

Comma-separated active shop ids. At most 100 non-blank values. Duplicates count toward that limit and are then ignored. Mutually exclusive with after. A blank value is rejected. Every id must be an active shop. External ids are not accepted.

shopIds
boolean
Defaults to false

When true, each shop includes tags with id, name, and parentTagId. Defaults to false. Repeat this value with after.

string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json