Search work locations
Searches the work locations of a single employer, identified by the path parameter {employerId}. Returns a page of work locations matching the supplied filters. Use the work-location metadata endpoint (/v1/employers/work-locations/metadata/search) to discover available field IDs and supported filter operators. There is no single-work-location endpoint — read one by filtering on /workLocation/id. (Work-location metadata is not employer-scoped; its endpoint is /v1/employers/work-locations/metadata/search.)
Before using this endpoint
- Discover readable field IDs (including custom fields) via the <a href="https://apidocs.hibob.com/reference/post_employers-work-locations-metadata-search" target="_blank">work-location metadata search endpoint</a>. Out-of-the-box field IDs are also listed as keys on the WorkLocation response schema for this search endpoint.
- Provide a numeric employerId in the path — use the employer search endpoint to look up employer IDs.
- There is no single-work-location endpoint — filter on /workLocation/id with operator equals to read one work location.
- Filterable field IDs: /workLocation/id, /workLocation/name, /workLocation/type, /workLocation/status, /workLocation/country. Any other fieldId in filters returns 400 Bad Request.
Pagination — cursor-based. next_cursor is null on the last page. Search does not support sorting — order results client-side.
Testing notes
- Use the testing widget's Try It! option to test this endpoint.
- Open Examples and select Request Example to populate the request body. Replace the path employerId with a real employer ID from your company.
- IDs must be sent as JSON strings even when they look numeric.
OAuth scope (app-user): employers:read. IAM permission: Settings / Employers / View (company-scoped).
Request
- Base URLhttps://api.hibob.com/v1
- URLhttps://api.hibob.com/v1/employers/{employerId}/work-locations/search
- Auth
- HTTP basic
- or HTTP bearer
Path parameters
Identifier of the parent employer whose work locations to search.
Request body
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.