Contracts

Reference

Collections

People

Contracts

The API provides access to contracts.
A contract represents an agreement between a person and the organization, defining employment terms such as period, hours, and type (contract or addendum).

Tip

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

Endpoints

Retrieve a contract Retrieve a list of contracts Retrieve a delta of contracts Webhooks of contracts

External references

The contracts collection supports both predefined and custom external references on related collections. More information can be found on the External References Page.

Collection	Predefined	Custom
`contracts`	—	Supported
`people`	`@badge-number`, `@employee-number`	Supported

Predefined example:
?externalReferences=(people,@badge-number)

Custom example:
?externalReferences=(contracts,customContractCode)

Multiple example:
?externalReferences=(contracts,customContractCode)(people,@badge-number)