List claims for open shifts
Returns claims for open shifts, newest first: someone asking to take a published open shift, and where it stands:
pending, approved, declined, withdrawn, taken (someone else got the shift) or expired. Filter by site, person
or status.
Scope: attendance:read · Plan: Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: attendance:read
limit?integerHow many items to return, from 1 to 100.
1 <= value <= 10025cursor?stringThe next_cursor from the previous page. Leave it out for the first page.
length <= 512site_id?stringOnly those at this site.
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"person_id?stringOnly this person's claims.
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$"person_01kjsesxm0e4zbyvkr7bcfxbfg"status?stringOnly those in this state.
A page of claims.
application/json- response
data*array<>next_cursor*|Pass this as cursor to get the next page. null on the last page.
"b3BhcXVlLWN1cnNvcg"has_more*booleancurl -X GET 'https://api.agoo.ardent.africa/v1/shift-claims?limit=25'{ "data": [ { "id": "shift_claim_01m5a2wsp4k55wjfe13p30bjq7", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "status": "pending", "shift": { "id": "roster_shift_01m5dk4qexa6kwfsr9nhy4r7w5", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "person_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "open": true, "on_date": "2019-08-24", "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z", "start_time": "20:00", "end_time": "08:00", "shift_id": "shift_01kn6pqfm0fmasbh61jnr3syze", "name": "Night gate", "label": "Main gate", "colour": "blue", "break_kind": "none", "break_minutes": 0, "break_starts": "string", "note": "string", "status": "draft", "pending_change": true, "removing": true, "source": "pattern", "published_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "person_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "note": "string", "decision_note": "string", "approval": { "status": "pending", "step": 0, "of": 0 }, "created_at": "2019-08-24T14:15:22Z", "decided_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "b3BhcXVlLWN1cnNvcg", "has_more": true}Approve or decline a shift swap POST
Approves or declines a swap waiting for approval (`status: accepted`), all its approval steps at once (your organisation's approvers decide step by step in Agoo Workspace and the Console). Approving moves the shift to the colleague who took it (and the shift asked for in return to the person who offered it), and both are told; it's refused with `conflict` when either now has a shift at that time. A decline needs a `note` they see. A swap that isn't waiting returns `invalid_state`. `shift_swap.approved` or `shift_swap.declined` fires. **Scope:** `attendance:manage` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Get a claim for an open shift GET
Returns one claim for an open shift. **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.