post
https://api.hibob.com/v1/employers/work-locations/metadata/search
Discover the readable work-location field catalog, including custom fields.
Returns the field catalog for the workLocation object — the set of fields
a client can read, with their types, validations, and status. Use it to
discover the path-style field IDs (for example /workLocation/name) that
drive the work-location search endpoint. The catalog is the same across
employers, so this endpoint is not scoped to a specific employer.
Out-of-the-box fields are documented on the search endpoint; metadata search
is primarily useful for discovering custom fields.
Before using this endpoint
- Use this endpoint before the work-location search endpoint to discover the
full field catalog — every readable field ID (including custom fields), its
type, and status. - Out-of-the-box field IDs are also listed as keys on the
WorkLocation
response schema on the search endpoint. - Send an empty body (
{}) to return the object with default properties and
all active fields.
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.
OAuth scope (app-user): employers:read.
IAM permission: Settings / Employers / View (company-scoped).

