AveeCare

Retrieve an open shift

get/v1/open-shifts/{id}

Returns one open shift by ID. Available to keys belonging to office staff and caregivers.

Authorization

Authorization: Bearer ak_...requiredscope: read

An AveeCare API key created in Settings → API Keys. A read or read + write key can call this endpoint. About authentication

Path parameters

id
stringrequired

ID of the open shift.

Response

200

The open shift.

object
stringread-only

String representing the object's type. Always open_shift.

id
stringread-only

Unique identifier of the open shift.

visitId
string | nullmax length 64

The unassigned visit being offered.

broadcastDate
string · date-time | null

When the shift was offered.

status
string | null

Whether the offer is still open.

One ofActiveFilledCancellednull
acceptedBy
string | nullread-onlymax length 64

The caregiver who claimed the shift.

createdAt
string · date-time | nullread-only

When the open shift was created.

updatedAt
string · date-time | nullread-only

When the open shift was last changed.

Response headers

Request-IdstringUnique ID of this request. Quote it when contacting support.
RateLimit-LimitintegerRequests allowed in the current window.
RateLimit-RemainingintegerRequests left in the current window.
RateLimit-ResetintegerSeconds until the window resets.

Errors

StatusCodeMeaning
401
n/a
The API key is missing, malformed, expired or revoked (unauthorized).
403
n/a
The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden).
404
n/a
No such object, or it is not visible to this key (not_found).
429
n/a
Too many requests (rate_limited). Wait for Retry-After seconds.
500
n/a
Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists.

Every error uses the same body. See Errors for the full list of codes.