Get employer metadata

Discover the readable employer field catalog, including custom fields.

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).

Body Params

Request body for an employer metadata search. All members are optional —
send an empty body ({}) to return the object with its default properties.

Request body for an employer metadata search. All members are optional —
send an empty body ({}) to return the object with its default properties.

objectProperties
array of strings | null
Defaults to []

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

objectProperties
fields

Field-selection options. When omitted, the response does not include the
fields array.

Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json