Retrieve a list

Retrieve a list

Introduction

You can retrieve a list of all employers in the system.

Tip

Check the Swagger page for more technical information on the endpoints.

Endpoint details

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

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.

Filters

This endpoint does not require any filter parameters. It returns all employers in the system.

External references

This endpoint does not require any external references.

Examples

Retrieve all employers

Example to retrieve all employers that have been configured in Protime:

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