Get a shift swap
Returns one shift swap.
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
shift_swap_id*stringThe shift swap's ID.
^shift_swap_[0-7][0-9a-hjkmnp-tv-z]{25}$"shift_swap_01m5rqnybsm3s6ta3zbtb975p6"The shift swap.
application/json- response
A published shift offered to a colleague (or anyone who can take it), and where it stands.
id*ShiftSwapIdA shift swap ID (TypeID with the shift_swap prefix).
^shift_swap_[0-7][0-9a-hjkmnp-tv-z]{25}$"shift_swap_01m5rqnybsm3s6ta3zbtb975p6"site_id*SiteIdA site ID (TypeID with the site prefix).
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"status*string"offered""accepted""approved""declined""refused""withdrawn""expired""cancelled"shift*A shift on a site's roster. A published shift with a change waiting shows its published values.
return_shift*|An exchange: the colleague's shift the person offering takes in return.
from_person_id*PersonIdA person ID (TypeID with the person prefix).
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$"person_01kjsesxm0e4zbyvkr7bcfxbfg"to_person_id*|The colleague it was offered to; null: anyone who can take it.
taker_person_id*|nullnote*string|nulldecision_note*string|nullapproval*|Where its approval stands; null when it needed none.
created_at*stringdate-timeaccepted_at*|date-timedecided_at*|date-timeupdated_at*stringdate-timecurl -X GET 'https://api.agoo.ardent.africa/v1/shift-swaps/shift_swap_01m5rqnybsm3s6ta3zbtb975p6'{ "id": "shift_swap_01m5rqnybsm3s6ta3zbtb975p6", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "status": "offered", "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" }, "return_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" }, "from_person_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "to_person_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "taker_person_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "note": "string", "decision_note": "string", "approval": { "status": "pending", "step": 0, "of": 0 }, "created_at": "2019-08-24T14:15:22Z", "accepted_at": "2019-08-24T14:15:22Z", "decided_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}List shift swaps GET
Returns shift swaps, newest first: a published shift someone offered to a colleague (or to anyone who could take it), sometimes for one of the colleague's shifts in return, and where it stands: `offered`, `accepted` (taken, waiting for approval), `approved`, `declined`, `refused` (the colleague said no), `withdrawn`, `expired` (the shift started first) or `cancelled` (the shift changed). Filter by site, by a person in it, or by status. **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
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.