Skip to navigation
API ReferenceEmployers

Retrieve an employer

Retrieves an employer object.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

employer_idstringRequiredformat: "er_.+"

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK
idstringformat: "er_.+"
legal_namestring
legal_addressobject
contactobject
platform_idstringOptionalformat: "pt_.+"
statusenumOptional
Allowed values:
registration_numberstring or nullOptional
offboard_ondatetime or nullOptional
earliest_benefits_start_datedate or nullOptional
applicable_collective_agreementstring or nullOptional
Name of the collective agreement that applies to the employer's workforce, if any.
metadatamap from strings to strings or nullOptional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.

objectstringOptionalRead-only
The object type

Errors

404
Not Found Error