Retrieve a contract

Introduction

You can retrieve a contract by its internal ID or an external reference using the GET call. Internal IDs for contracts can be found by listing all contracts using the GET collection endpoint.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/contracts/{contractReference}

URL parameters

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

Parameter	Description
<contractReference>	The internal ID or external reference of the contract.

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 contract record.
person.id	integer	Internal ID of the person.
code	string	The Contract code.
from	string	Start date of the contract for when it’s active.
until	string	End date of the contract.
contractHoursInMinutes	integer	Contracted hours in minutes.
fullTimeEquivalentInMinutes	integer	The equivalent in minutes for a full-time contract.
contractPercentage	number	Percentage of full-time contract.
numberOfWorkingDaysPerWeek	number	The number of working days per week.
numberOfDaysInContractPeriod	integer	The number of days in the contract period.
kind	string	The kind of contract (Contract,Addendum).
parentContract.id	integer	Identifier of the parent contract.

External references

It’s possible to use predefined external references and custom external references. More information can be found on the External References Page

For a list of predefined external references, see the external reference options section.

Examples

Retrieving a contract by internal ID

Example with internal ID 123:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/contracts/123

With custom external reference

Example with custom external reference CONTRACT-2025:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/contracts/CONTRACT-2025?externalReferences=(contracts,customContractCode)