List User Availability Schedules | Calendly

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.availability.listUserAvailabilitySchedules({
        user: "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
    });
}
main();

{
  "collection": [
    {
      "uri": "https://api.calendly.com/user_availability_schedule/AAAAAAAAAAAAAAAA",
      "default": true,
      "name": "Working Hours",
      "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "timezone": "America/New_York",
      "rules": [
        {
          "type": "wday",
          "intervals": [
            {
              "from": "08:30",
              "to": "09:30"
            }
          ],
          "wday": "sunday",
          "date": "2022-12-31"
        }
      ]
    },
    {
      "uri": "https://api.calendly.com/user_availability_schedule/BBBBBBBBBBBBBBBB",
      "default": false,
      "name": "Evening Hours",
      "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "timezone": "America/New_York",
      "rules": [
        {
          "type": "wday",
          "intervals": [
            {
              "from": "08:30",
              "to": "17:00"
            }
          ],
          "wday": "monday"
        },
        {
          "type": "wday",
          "intervals": [
            {
              "from": "08:30",
              "to": "17:00"
            }
          ],
          "wday": "tuesday"
        },
        {
          "type": "wday",
          "intervals": [],
          "wday": "wednesday"
        },
        {
          "type": "wday",
          "intervals": [
            {
              "from": "08:30",
              "to": "17:00"
            }
          ],
          "wday": "thursday"
        },
        {
          "type": "wday",
          "intervals": [
            {
              "from": "08:30",
              "to": "17:00"
            }
          ],
          "wday": "friday"
        },
        {
          "type": "wday",
          "intervals": [],
          "wday": "saturday"
        },
        {
          "type": "date",
          "intervals": [
            {
              "from": "08:30",
              "to": "09:30"
            }
          ],
          "date": "2028-12-31"
        }
      ]
    }
  ]
}

Returns the availability schedules of the given user.

Required scopes

availability:read

Returns the availability schedules of the given user. <Info title="Required scopes"> > `availability:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

userstringRequiredformat: "uri"

A URI reference to a user

Response

collectionlist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	{
2	"collection": [
3	{
4	"uri": "https://api.calendly.com/user_availability_schedule/AAAAAAAAAAAAAAAA",
5	"default": true,
6	"name": "Working Hours",
7	"user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
8	"timezone": "America/New_York",
9	"rules": [
10	{
11	"type": "wday",
12	"intervals": [
13	{
14	"from": "08:30",
15	"to": "09:30"
16	}
17	],
18	"wday": "sunday",
19	"date": "2022-12-31"
20	}
21	]
22	},
23	{
24	"uri": "https://api.calendly.com/user_availability_schedule/BBBBBBBBBBBBBBBB",
25	"default": false,
26	"name": "Evening Hours",
27	"user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
28	"timezone": "America/New_York",
29	"rules": [
30	{
31	"type": "wday",
32	"intervals": [
33	{
34	"from": "08:30",
35	"to": "17:00"
36	}
37	],
38	"wday": "monday"
39	},
40	{
41	"type": "wday",
42	"intervals": [
43	{
44	"from": "08:30",
45	"to": "17:00"
46	}
47	],
48	"wday": "tuesday"
49	},
50	{
51	"type": "wday",
52	"intervals": [],
53	"wday": "wednesday"
54	},
55	{
56	"type": "wday",
57	"intervals": [
58	{
59	"from": "08:30",
60	"to": "17:00"
61	}
62	],
63	"wday": "thursday"
64	},
65	{
66	"type": "wday",
67	"intervals": [
68	{
69	"from": "08:30",
70	"to": "17:00"
71	}
72	],
73	"wday": "friday"
74	},
75	{
76	"type": "wday",
77	"intervals": [],
78	"wday": "saturday"
79	},
80	{
81	"type": "date",
82	"intervals": [
83	{
84	"from": "08:30",
85	"to": "09:30"
86	}
87	],
88	"date": "2028-12-31"
89	}
90	]
91	}
92	]
93	}