API ReferenceEmployers

Retrieve an employer

Retrieves an employer object.

Path parameters

employer_idstringRequiredformat: "er_.+"

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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"
objectstring or null
The object type

Errors