Reference
Collections
Shift definitions

Shift definitions

The API provides access to shift definitions. For background on how shift definitions behave, see Shift definition behaviour.

Tip

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

Endpoints

Retrieve a shift definition Retrieve a list of shift definitions Retrieve a delta of shift definitions Webhooks of shift definitions

External references

The shift-definitions collection supports both predefined and custom external references. More information can be found on the External References Page.

Type External reference Description
Predefined @shift-code The shift code configured in Protime for the shift definition.
Custom customShiftCode A custom key-value pair managed by the 3rd party.

Usage in other collections

Shift-definitions external references can also be used in the following collections:

Predefined example:
?externalReferences=(shift-definitions,@shift-code)

Custom example:
?externalReferences=(shift-definitions,customShiftCode)