Get Attendance Shifts Schedule Report

Attendance report 2: active shift assignments per employee.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired

Headers

Secret-AccessstringRequired

Query parameters

centralized_user_idintegerOptional

Centralized id of the employee to filter by. Note: this is not the learning user_id used by the /reports/learning/… reports — for the same person they are different numbers.

from_datestringOptional

Start of the range, in YYYY-MM-DD format. Inclusive. With no to_date the range stays open going forward. Applies to the start of the assignment (start_date).

to_datestringOptional

End of the range, in YYYY-MM-DD format. Inclusive: the whole day is covered, not just its midnight. For a single day, send the same date in from_date and in to_date. Applies to the start of the assignment (start_date).

limitintegerOptional1-500Defaults to 100
Rows per page, up to 500. Defaults to 100 when omitted.
offsetintegerOptional>=0

Rows to skip before the page. Use it together with limit to walk the report: 0, then limit, then twice limit, and so on.

Response

Successful Response
resultslist of objects
totalintegerOptional

Errors

400
Bad Request Error
422
Unprocessable Entity Error