calendar
busy

List all busies

get/calendar/{connection_id}/busy

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/calendar/{connection_id}/busy
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
querystring

Query string to search. eg. email address or name

calendar_idstring

The calendar ID to get availability for. Typically user's email or user ID. (reference to CalendarCalendar)

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
start_atstring date-time required

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time required

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

timezonestring
descriptionstring
rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.