Create Request Endpoint

Create one or more schedule / time-off / claim requests. Body is {items: [RequestIn, ...]} like POST /approve; a single RequestIn object is also accepted. Each item is RequestItem-shaped: type, person_id, requested_entries. resource_id is required for modify_ and cancel_. Optional decision defaults to approved so validation may leave it pending; pass pending to keep it pending. Returns 409 if that resource already has a pending request. Items and requested_entries for the same person whose windows fall in the same work week (that person's weekday_start) are submitted together so weekly rules apply to the full week, then returned 1:1 with the input items. Pass validate_only=true to run the same checks without writing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Run create checks without persisting

Body Params
items
array of objects
required
length ≥ 1

One or more request payloads. Items and requested_entries for the same person whose windows fall in the same work week are submitted together so weekly rules apply to the full week.

Items*

One request to create or approve/deny. It is an approval when resource_id points
at a row that already has a pending request and decision is not pending; otherwise
it is a create.

string
enum
required
Allowed:

Shift / unavailability id, or synthetic negative id for availability. Required for modify_, cancel_ and any approve/deny. Omit for a new time_off or availability. For claim_shift this is the open shift id.

Person the request is for. Required when there is no resource_id; otherwise read off the row.

Label time; derived from the resource or first requested_entry when omitted

requested_entries
array of objects

Proposed / desired entries. Empty for cancels and for plain time_off approvals.

Requested Entries
string
enum
Defaults to approved

pending submits as a pending request. approved submits as approved (validation may still drop it to pending) or approves a pending request. denied denies a pending request. cancelled withdraws a pending request (a deny by the requester).

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json