Get a team member's schedule

Request

Returns the configured working schedule of a Team Member for a date range — the days and working slots set by the business. This is not availability: free bookable slots come from GET /locations/{location_id}/availability.

The response carries an ETag header for a subsequent schedule PATCH.

Security

OAuth2(Required scopes: team_members:read) or RestrictedKey

Path

location_idintegerrequired

Identifier of the Location. Verified against the credential on every call — a Location the credential cannot access responds with 404.

team_member_idintegerrequired

Identifier of the Team Member.

Query

date_fromstring, (date)required

First date of the range (inclusive), YYYY-MM-DD.

date_tostring, (date)required

Last date of the range (inclusive), YYYY-MM-DD.

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v3/openapi/locations/{location_id}/team_members/{team_member_id}/schedule?date_from=2019-08-24&date_to=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Working days within the requested range.

Headers

RateLimit-Remaininginteger, (int32), >= 0

Requests left in the most constrained policy window that applies to this request.

RateLimit-Resetinteger, (int32), >= 0

On 429, seconds until the most constrained policy frees up; it equals Retry-After there. On a successful response it reports the length of that policy's window rather than the time left in the current one, so treat it as the window size, not as a countdown — the counter to pace against is RateLimit-Remaining.

RateLimit-Policystring

Most constrained policy applied to the request, as <limit>;w=<window in seconds>.

Example:"10;w=60"

ETagstring

Version tag of the returned resource. Send it back in If-Match on the next PATCH or DELETE.

X-Request-Idstring

Request identifier for support and log correlation.

Bodyapplication/json

dataArray of objects(ScheduleDay)required

has_morebooleanrequired

Whether more items exist beyond this page.

next_cursorstring or nullrequired

Opaque cursor for the next page; null on the last page.

objectstringrequired

Value:"list"

Response

{
  "object": "list",
  "data": [
    { … },
    { … }
  ],
  "has_more": false,
  "next_cursor": null
}