Requests

What people asked for, and what became of it — leave, schedule changes, corrections and money.

Read this to learn that a timesheet moved. Half of everything here is a batch clock-in correction: somebody forgot to punch, a manager approved the fix, and the attendance for those days changed after the fact. Only 48 per cent of those are approved within three days of the day they correct, and a third reach back more than a week — so a caller that pulled a timesheet last week cannot assume it still holds. Attendance carries no timestamps of its own, which makes this listing paged on updated_since the only signal that anything has moved.

period is the field that makes that usable: the span of days a request concerns, wherever its kind happens to keep them. A clock-in correction keeps them inside the punches, a leave request as a period or a list, a request for a certificate not at all — both ends are null there rather than invented.

subtype is the second half of type, and the product keeps it in two different places — content.type for most kinds, content.leave_type for leave. It is answered as one field, and subtypes filters on both.

comment is what the author wrote when filing it, ordinarily the reason. Comments the workflow writes itself — on acknowledgement, or when a spawned task closes — are not answered here.

Oldest first. A first call lands on the earliest request this company ever filed, which for a long-standing one is years back. That order is what lets a full export finish in one walk, and it is not what you want for "what changed lately": ask with updated_since.

content is behind include=content: its shape depends on the kind, and one schema describes one shape everywhere else on this surface.

Reading only. Creating a request enters a workflow — approval routes resolve, approvers are notified, tasks are spawned — and approving one is a person's decision that a dismissal application or a sick note gives weight to.

get/company/v3/user-requests

Request

  • Base URL: https://api.clockster.com
  • URL: https://api.clockster.com/company/v3/user-requests
  • Auth: HTTP bearer

Query parameters

per_pageinteger

How many rows one page holds. Defaults to 50.

cursorstring nullable

The meta.next_cursor of the previous page. Omit it for the first. A cursor is bound to the filters it was issued under — change them and start again.

typesstring[] nullable

Only rows of these types.

statusesstring[] nullable

Only rows in these states.

subtypesstring[] nullable

Only rows of these subtypes, which narrow a type further.

usersinteger[] nullable

Only rows belonging to these people, by id.

updated_sincestring date-time nullable

Only rows changed at or after this instant (ISO 8601). The cheap way to sync: ask for what moved, not for everything.

includestring[] nullable

Relations to load, comma-separated. Anything not named is absent from the answer rather than null.

Response

Success

Changes

    • info

      the endpoint scheme security companyToken was added to the API

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property /// became optional for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status