Retrieve an employer

Returns a single employer by its internal ID or external reference.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers/{employerReference}

Headers: Authorization: Bearer {token}, User-Agent: {agent} Scope: connector-protimeapi-employers.read

URL parameters

Parameter	Description
{employerReference}	The internal ID or external reference of the employer.

Response properties

Field	Type	Required	Writable	Description
changeVersion	string	—	Read-only	Property to indicate the order of changes.
id	integer	—	Read-only	Unique identifier for the employer.
name.default	string	Yes	Yes	Default name of the employer.
name.translations	object	No	Yes	Translated names for supported languages.
externalCode	string	No	Yes	External code for the employer.
address	string	No	Yes	Street address of the employer.
town	string	No	Yes	Town or city of the employer.
postalCode	string	No	Yes	Postal code of the employer.
bankAccount	string	No	Yes	Bank account number of the employer.
companyRegistrationNumber	string	No	Yes	Company registration number.

External references

The endpoint supports custom external references. See the external references page for details.

Error responses

Status	Condition
400	Invalid external reference specification (e.g., unsupported predefined reference or non-integer ID without external reference)
401	Missing or invalid access token, or insufficient scope
404	Employer with the given ID or external reference not found

Examples

Retrieve one employer

Example retrieving an employer with internal ID 456:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers/456

Retrieve an employer with a custom external reference

Example retrieving an employer with a custom external code 789:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers/789?externalReferences=(employers,CustomReferenceName)