EndpointsReports

Get Attendance Shifts Report

Attendance report 1: catalog of configured shifts (one per row).

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

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 shift creation date (created_at). Unlike the other Attendance reports, there is no dated event to filter on here: what the range narrows down is when the shift was configured.

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 shift creation date (`created_at`). Unlike the other Attendance reports, there is no dated event to filter on here: what the range narrows down is when the shift was configured.
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