Skip to main content
Users

Get a user's configured availability

GET
/users/{id}/availability
Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

idstringrequired
startstringquery

Start of the exception window. Defaults to now.

endstringquery

End of the exception window, after start, at most 366 days later. Defaults to 31 days after start, or after now.

Response

application/json

Weekly windows and exceptions

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

exceptionsobject[]required

Exceptions overlapping the requested window.

user_idstringrequired
weekly_availabilityobject[]required

Configured weekly working windows, sorted by day then start.