List User Busy Times | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.availability.listUserBusyTimes({
        endTime: "2020-01-08T20:30:00.000000Z",
        startTime: "2020-01-02T20:00:00.000000Z",
        user: "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
    });
}
main();

{
  "collection": [
    {
      "type": "calendly",
      "start_time": "2020-01-02T20:00:00.000000Z",
      "end_time": "2020-01-02T20:30:00.000000Z",
      "buffered_start_time": "2020-01-02T19:30:00.000000Z",
      "buffered_end_time": "2020-01-02T21:00:00.000000Z",
      "event": {
        "uri": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA"
      }
    },
    {
      "type": "calendly",
      "start_time": "2020-01-05T20:00:00.000000Z",
      "end_time": "2020-01-05T20:30:00.000000Z",
      "buffered_start_time": "2020-01-05T19:30:00.000000Z",
      "buffered_end_time": "2020-01-05T21:00:00.000000Z",
      "event": {
        "uri": "https://api.calendly.com/scheduled_events/BBBBBBBBBBBBBBBB"
      }
    },
    {
      "type": "reserved",
      "start_time": "2020-01-07T17:00:00.000000Z",
      "end_time": "2020-01-07T17:30:00.000000Z"
    },
    {
      "type": "reserved",
      "start_time": "2020-01-07T18:00:00.000000Z",
      "end_time": "2020-01-07T18:30:00.000000Z"
    },
    {
      "type": "external",
      "start_time": "2020-01-07T20:00:00.000000Z",
      "end_time": "2020-01-07T20:30:00.000000Z"
    }
  ]
}

Returns an ascending list of user internal and external scheduled events within a specified date range.

Date range can be no greater than 1 week (7 days).

NOTE:

This endpoint does not support traditional keyset pagination.
External events will only be returned for calendars that have “Check for conflicts” configured.

Required scopes

availability:read

Returns an ascending list of user internal and external scheduled events within a specified date range. Date range can be no greater than 1 week (7 days). **NOTE:** * This endpoint does not support traditional keyset pagination. * External events will only be returned for calendars that have "Check for conflicts" configured. <Info title="Required scopes"> > `availability:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

userstringRequiredformat: "uri"

The uri associated with the user

start_timestringRequired

Start time of the requested availability range. Date cannot be in the past.

end_timestringRequired

End time of the requested availability range. Date must be in the future of start_time.

Response

collectionlist of objects

The set of internal and external scheduled calendar events matching the criteria

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

424

Failed Dependency Error

500

Internal Server Error