Assignments

Reference

Collections

Assignments

Through the API there’s a possibility to retrieve, create, update and delete assignments. Assignments represent scheduled work periods for employees.

Tip

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

Endpoints

Retrieve an assignment Retrieve a list of assignments Create an assignment Update an assignment Delete an assignment Retrieve a delta of assignments Webhooks of assignments

External references

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

Collection	Predefined	Custom
`people`	`@badge-number`, `@employee-number`	Supported
`activity-definitions`	`@data-entry-code`, `@external-reference`	Supported

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

Custom example:
?externalReferences=(people,customPeopleCode)

Multiple example:
?externalReferences=(people,@employee-number)(activity-definitions,@data-entry-code)