ShiftCare API v3 (0.0.1)

List account locations for the current account with pagination, optional filtering by ID or name, and sorting by ID or name; access is gated by a feature flag.

List areas for the current account with pagination, optional filtering by ID or name, and sorting by ID or name; access is gated by a feature flag.

Create external IDs for leave

update a leave

show leaves

create leave

leave

Show an external reference by external_id

Bulk destroy external references for supported resources

Bulk update external references for supported resources

Bulk create external references for supported resources

facilities

Creates a single shift, or a recurring series when recurrence is provided.

Recurring series expansion: up to 20 shifts are created synchronously before the response returns. When a series exceeds 20 shifts, the first 20 are created immediately (and the lead shift is returned in the response) while the remaining shifts are enqueued and created asynchronously under the same program_id. Poll GET /v3/shifts filtered by program_id to see the full series once expansion completes.

Request body format (JSON)

JSON is recommended for any request that includes nested fields (clients, staff, recurrence) — the form-encoded bracket notation in the parameter list below does not produce the array-of-objects shape this endpoint expects for those fields.

clients and staff are arrays of objects, not parallel arrays of fields. recurrence is a single nested object.

{
  "area_id": 1234,
  "start_at": "2026-04-25T09:00:00+10:00",
  "end_at": "2026-04-25T17:00:00+10:00",
  "shift_type": "standard",
  "published": true,
  "allowance_ids": [10, 11],
  "clients": [
    { "client_id": 1045508, "price_book_id": 222, "fund_id": 751168 }
  ],
  "staff": [
    { "staff_id": 5001, "pay_group_id": 12 }
  ],
  "recurrence": {
    "unit": "week",
    "repeat_every": 1,
    "week_days": "Mon,Wed,Fri",
    "end_at": "2026-06-30"
  }
}

Sending a hash-of-arrays shape (e.g. "clients": { "client_id": [1045508], "fund_id": [751168] }) will fail validation with "Clients is invalid". Use the array-of-objects shape shown above.

shifts

shift

Permanently deletes a shift. Returns 204 No Content on success.

State rules:

• Invoiced shifts cannot be deleted — returns 409.
• Calendar sync, program-recurrence end_at, and industry-award validation are handled automatically.

Updates a single shift. All body fields are optional — only the fields provided are changed.

State rules:

• Invoiced shifts cannot be updated — returns 409.
• Cancelled shifts only accept changes to cancelled_reason (and the meta notify flag) — any other field returns 409.
• cancelled_reason is rejected on active (non-cancelled) shifts — returns 422.

Request body format (JSON)

JSON is recommended for any request that includes nested fields (clients, staff) — the form-encoded bracket notation in the parameter list below does not produce the array-of-objects shape this endpoint expects for those fields.

clients and staff are arrays of objects, not parallel arrays of fields. Sending either replaces the existing assignments wholesale.

{
  "start_at": "2026-04-25T09:00:00+10:00",
  "end_at": "2026-04-25T17:00:00+10:00",
  "published": true,
  "allowance_ids": [10, 11],
  "clients": [
    { "client_id": 1045508, "price_book_id": 222, "fund_id": 751168 }
  ],
  "staff": [
    { "staff_id": 5001, "pay_group_id": 12 }
  ]
}

Sending a hash-of-arrays shape (e.g. "clients": { "client_id": [1045508], "fund_id": [751168] }) will fail validation with "Clients is invalid". Use the array-of-objects shape shown above.

Cancels a shift via the same flow used by the scheduler UI.

cancel_type:

• without_charge — sets cancelled_at + cancelled_reason on the shift; not billed.
• with_charge — marks each ratio absent with absent_reason; ratios remain billable.

Audit trail:

• Under API-key auth (no current_user), the action is attributed to the account owner in the audit log / PaperTrail.

List staff members for a shift