List User's Event Types | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.eventTypes.listEventTypes({
        sort: "name:asc",
    });
}
main();

{
  "collection": [
    {
      "active": true,
      "admin_managed": false,
      "booking_method": "instant",
      "color": "#fff200",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "custom_questions": [
        {
          "name": "Company Name",
          "type": "string",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        },
        {
          "name": "What would you like to discuss?",
          "type": "text",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        },
        {
          "name": "Number of employees",
          "type": "single_select",
          "position": 2,
          "enabled": true,
          "required": false,
          "answer_choices": [
            "1",
            "2-10",
            "11-20",
            "20+"
          ],
          "include_other": true
        },
        {
          "name": "Multi-Select Question",
          "type": "multi_select",
          "position": 2,
          "enabled": true,
          "required": false,
          "answer_choices": [
            "Answer 1",
            "Answer 2",
            "Answer 3",
            "Answer 4"
          ],
          "include_other": true
        },
        {
          "name": "Phone Number",
          "type": "phone_number",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        }
      ],
      "deleted_at": null,
      "description_html": "<p>15 Minute Meeting</p>",
      "description_plain": "15 Minute Meeting",
      "duration": 15,
      "duration_options": [
        1,
        13,
        15,
        720
      ],
      "internal_note": "Internal note",
      "is_paid": false,
      "kind": "solo",
      "locale": "en",
      "locations": [
        {
          "kind": "inbound_call",
          "additional_info": "Additional information about location",
          "phone_number": "+ 380934567654"
        }
      ],
      "name": "15 Minute Meeting",
      "pooling_type": "round_robin",
      "position": 0,
      "profile": {
        "type": "User",
        "name": "Tamara Jones",
        "owner": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
      },
      "scheduling_url": "https://calendly.com/acmesales",
      "secret": true,
      "slug": "acmesales",
      "type": "StandardEventType",
      "updated_at": "2019-08-07T06:05:04.321123Z",
      "uri": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA"
    }
  ],
  "pagination": {
    "count": 20,
    "next_page": "https://api.calendly.com/event_types?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page": "https://api.calendly.com/event_types?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H",
    "next_page_token": "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page_token": "VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H"
  }
}

Returns all Event Types associated with a specified User. Use:

organization to look up all Event Types that belong to the organization
user to look up a user’s Event Types in an organization

Either organization or user are required query params when using this endpoint.

Required scopes

event_types:read

Returns all Event Types associated with a specified User. Use: * `organization` to look up all Event Types that belong to the organization * `user` to look up a user's Event Types in an organization Either `organization` or `user` are required query params when using this endpoint. <Info title="Required scopes"> > `event_types:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

activebooleanOptional

Return only active event types if true, only inactive if false, or all event types if this parameter is omitted.

organizationstringOptionalformat: "uri"

View available personal, team, and organization event types associated with the organization's URI.

userstringOptionalformat: "uri"

View available personal, team, and organization event types associated with the user's URI.

user_availability_schedulestringOptionalformat: "uri"

Used in conjunction with user parameter, returns a filtered list of Event Types that use the given primary availability schedule.

sortstringOptionalDefaults to name:asc

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values.Supported fields are: name, position, created_at, updated_at. Sort direction is specified as: asc, desc.

admin_managedbooleanOptional

Return only admin managed event types if true, exclude admin managed event types if false, or include all event types if this parameter is omitted.

page_tokenstringOptional

The token to pass to get the next or previous portion of the collection

countintegerOptional1-100Defaults to 20

The number of rows to return

Response

collectionlist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error