GuidesReferenceChangelogAPI Upgrades
Reference

List workplaces

get
https://sandbox.checkhq.com/workplaces

Returns a list of workplaces.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Return workplaces for this company ID.

int32
Defaults to 25

Number of workplaces returned per page. The maximum value is 500.

id
array of strings

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

id
metadata
object

Return only results whose metadata contains every given key and value, for example metadata[external_id]=123. Pass keys using bracket notation. Multiple keys are combined with AND. Brackets must be URL-encoded in request URLs (metadata%5Bkey%5D=value).

Response

Updated 12 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago

Did this page help you?