Employers

Get employer metadata

Returns the field catalog for the employer 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 /employer/legalName) that drive the employer search endpoint. 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 employer 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 Employer 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).

post/employers/metadata/search

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/employers/metadata/search
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

objectPropertiesstring[] nullable

Object properties to fetch. When empty, only id is returned.

Response

Metadata-search response. Follows the OOTB-object metadata-search guideline: a list of object-metadata entries, each with its properties and (optionally) its field definitions.

Changes

No recorded changes to this operation across all 1 revision of this API.