API ReferenceEmployers

Retrieve an employer

Retrieves an employer object.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path Parameters

employer_idstringRequiredformat: "er_.+"

Response

OK
idstringformat: "er_.+"
legal_namestring
legal_addressobject
contactobject
platform_idstring or nullformat: "pt_.+"
statusenum or null
Allowed values:
registration_numberstring or null
offboard_onstring or nullformat: "date-time"
earliest_benefits_start_datestring or nullformat: "date"
metadatamap from strings to strings or null

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.

objectstring or null
The object type

Errors