DocsAPI ReferenceCalendar/bff/calendar/colleague-overlay
getCalendarAdmin BFF

/bff/calendar/colleague-overlay

Returns the same overlay shape as /my-overlay, but computed for a colleague that lives in the same organisation as the viewer. The colleague external events keep the cross-org privacy mask.

CalendargetBffCalendarColleague-overlay

Parameters

3 query

3 total
Query · 3
memberIdstringRequired

Wire-id of the colleague (the shop__contact.external_id returned by /bff/member/detail as id).

fromstringRequired

ISO-8601 lower bound.

tostringRequired

ISO-8601 upper bound.

Request

GET /bff/calendar/colleague-overlay

get
curl -X GET "https://api.bizkithub.com/bff/calendar/colleague-overlay?memberId=example_memberId&from=example_from&to=example_to" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key