Retrieve a list
Introduction
You can retrieve a list of shift definitions.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/shift-definitions
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 | Internal unique identifier for the shift definition. |
name.default |
string | Default name value of the shift definition. |
name.translations |
object | A list of translated names of the definition by language code. |
code |
string | A shift code used for this definition. |
friendlyName.default |
string | Default friendly name value for this definition shown to users. |
friendlyName.translations |
object | A list of translated friendly names by language code. |
isEnabled |
boolean | Indicates if the shift definition is enabled in myProtime. |
Filters
This endpoint does not require any filter parameters. It returns all shift definitions in the system.
External references
This endpoint does not require any external references.
Examples
Retrieving all shift definitions
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/shift-definitions