Skip to content

Get Team Member workload by day

Request

Returns, for each day of the period, booked time divided by scheduled working time for the selected Team Members. A ratio of 1 means booked time equals scheduled time. The ratio can exceed 1 because booked time is not clipped to scheduled hours. Use it to compare daily workload; it does not identify available appointment slots.

Only active Team Members that the Business User may see in the appointment calendar are included. The Business User needs access to the appointment calendar.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

Example:4564
Query
start_datestring, (date)required

Period start date (YYYY-MM-DD)

Example:start_date=2026-11-01
end_datestring, (date)required

Period end date (YYYY-MM-DD), inclusive

Example:end_date=2026-11-30
team_member_idinteger

Single Team Member ID. Takes precedence over team_member_ids[].

team_member_ids[]Array of integers

Team Member IDs. Without a Team Member filter, all active Team Members the Business User may see are used.

Headers
Acceptstringrequired
Default:"application/vnd.api.v2+json"
Content-Typestringrequired
Default:"application/json"
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/4564/team_members/workload?start_date=2026-11-01&end_date=2026-11-30&team_member_id=0&team_member_ids%5B%5D=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json
successboolean
dataArray of objects
metaobject
Response
{ "success": true, "data": [ { … }, { … } ], "meta": { "count": 2 } }