Retrieve an employer

Introduction

You can retrieve an employer by the internal ID or an external reference using the GET call.

Endpoint details

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

URL parameters

This parameter needs to be filled in when calling this endpoint.

Parameter	Description
<employerReference>	The internal ID or external reference of the employer.

Response properties

This list of properties is returned by this endpoint.

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

External references

It’s possible to use custom external references as a employerReference to retrieve an employer. More information can be found on the External References Page

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)