Search work locations

post

https://api.hibob.com/v1/employers/{employerId}/work-locations/search

Search and page through a specific employer's work locations.

Path Params

employerId

string

required

Identifier of the parent employer whose work locations to search.

Body Params

Request body for work-location search. filters is required — send an empty
array ([]) to return every work location of the employer. fields is
optional; omit it to return all available fields. limit defaults to 50.

fields

array of strings | null

Defaults to /workLocation/id,/workLocation/name,/workLocation/type,/workLocation/status

Field IDs to include in each result item. When omitted, all available
fields are returned. Discover the authoritative field catalog (including
custom fields) via the work-location metadata search endpoint;
out-of-the-box field IDs are also listed as keys on the WorkLocation
response schema.

fields

filters

array of objects

required

Defaults to []

Filters to apply within the employer's work locations. An empty list
returns every work location of the employer the caller has permission to
view.

filters*

limit

integer | null

1 to 200

Defaults to 50

Maximum number of items per page (allowed range 1–200). Defaults to 50.

cursor

string | null

Opaque cursor from a previous response's response_metadata.next_cursor.
Omit on the first request.

200Success

400Bad request — the request was malformed, missing required parameters, or referenced an unknown field ID or unsupported filter operator

401Unauthorized — authentication credentials are missing or invalid

403Forbidden — the caller lacks the required permission, the employers:read scope, or its source IP is not on the company IP trust list

429Too many requests — rate limit exceeded, retry after the indicated delay

500Internal server error — an unexpected error occurred on the server