{"openapi":"3.0.0","info":{"description":"Calendly scheduling API: event types, scheduled events and invitees, availability, organizations and memberships, routing forms, contacts, meeting recaps (Notetaker) and webhook subscriptions.","version":"v1"},"servers":[{"description":"Calendly scheduling API: event types, scheduled events and invitees, availability, organizations and memberships, routing forms, contacts, meeting recaps (Notetaker) and webhook subscriptions.","url":"https://api.apirails.com/calendly"}],"paths":{"/activity_log_entries":{"get":{"tags":["Activity Log"],"parameters":[{"name":"action","in":"query","description":"The action(s) associated with the entries","required":false,"schema":{"type":"array","example":""}},{"name":"actor","in":"query","description":"Return entries from the user(s) associated with the provided URIs","required":false,"schema":{"type":"array","example":""}},{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"max_occurred_at","in":"query","description":"Include entries that occurred prior to this time (sample time format: \"2020-01-02T03:04:05.678Z\"). This time should use the UTC timezone.","required":false,"schema":{"type":"string","example":""}},{"name":"min_occurred_at","in":"query","description":"Include entries that occurred after this time (sample time format: \"2020-01-02T03:04:05.678Z\"). This time should use the UTC timezone.","required":false,"schema":{"type":"string","example":""}},{"name":"namespace","in":"query","description":"The categories of the entries","required":false,"schema":{"type":"array","example":""}},{"name":"organization","in":"query","description":"Return activity log entries from the organization associated with this URI","required":true,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"search_term","in":"query","description":"Filters entries based on the search term. Supported operators: - `|` - to allow filtering by one term or another. Example: `this | that` - `+` - to allow filtering by one term and another. Example: `this + that` - `\"` - to allow filtering by an exact search term. Example: `\"email@website.com\"` - `-` - to omit specific terms from results. Example: `Added -User` - `()` - to allow specifying precedence during a search. Example: `(this + that) OR (person + place)` - `*` - to allow prefix searching. Example `*@other-website.com`","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Order results by the specified field and direction. List of {field}:{direction} values.","required":false,"schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/activity-log/list-activity-log-entries","api_endpoint":"https://api.calendly.com/activity_log_entries"},"summary":"List activity log entries","description":"<Info> > This endpoint requires an <strong>Enterprise</strong> subscription. </Info> <Info title=\"Required scopes\"> > `activity_log:read` </Info> Returns a list of activity log entries","security":[{"bearerAuth":[]}]}},"/user_availability_schedules/{uuid}":{"get":{"tags":["Availability"],"parameters":[{"name":"uuid","in":"path","description":"The UUID of the availability schedule.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/availability/get-user-availability-schedule","api_endpoint":"https://api.calendly.com/user_availability_schedules/{uuid}"},"summary":"Get User Availability Schedule","description":"This will return the availability schedule of the given UUID. <Info title=\"Required scopes\"> > `availability:read` </Info>","security":[{"bearerAuth":[]}]}},"/event_type_availability_schedules":{"get":{"tags":["Availability"],"parameters":[{"name":"event_type","in":"query","description":"The URI associated with the event type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/availability/get-event-type-availability","api_endpoint":"https://api.calendly.com/event_type_availability_schedules"},"summary":"List Event Type Availability Schedules","description":"Return the availability for an event type <Info title=\"Required scopes\"> > `availability:read` </Info>","security":[{"bearerAuth":[]}]},"patch":{"tags":["Availability"],"parameters":[{"name":"event_type","in":"query","description":"Event Type uri in which to update the availability schedule","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/availability/update-event-type-availability","api_endpoint":"https://api.calendly.com/event_type_availability_schedules"},"summary":"Update Event Type Availability Schedules","description":"Update an event type availability schedule <Info title=\"Required scopes\"> > `availability:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"availability_rule":{"type":"object","description":"Availability Rule","required":true,"properties":{"rules":{"type":"array","description":"The rules for an availability schedule.<br> <span style=\"color:red\">Warning: </span>Updating rules will overwrite all existing rules for the event type. Use the GET endpoint to first retrieve the existing rules and then pass the modified rules to the rules object."},"timezone":{"type":"string","description":"The timezone for which this Event Type Availability Schedule is originated in.","required":true},"user":{"type":"string","description":"Required when an admin or org owner is making the call to update a specific users availability schedule"}}},"availability_setting":{"type":"string","description":"By default every host on the Event Type shares an identical schedule.","enum":["host"]}}},"example":{"availability_rule":{},"availability_setting":"host"}}}}}},"/user_availability_schedules":{"get":{"tags":["Availability"],"parameters":[{"name":"user","in":"query","description":"A URI reference to a user","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/availability/list-user-availability-schedules","api_endpoint":"https://api.calendly.com/user_availability_schedules"},"summary":"List User Availability Schedules","description":"Returns the availability schedules of the given user. <Info title=\"Required scopes\"> > `availability:read` </Info>","security":[{"bearerAuth":[]}]}},"/user_busy_times":{"get":{"tags":["Availability"],"parameters":[{"name":"end_time","in":"query","description":"End time of the requested availability range. Date must be in the future of start_time.","required":true,"schema":{"type":"string","example":""}},{"name":"start_time","in":"query","description":"Start time of the requested availability range. Date cannot be in the past.","required":true,"schema":{"type":"string","example":""}},{"name":"user","in":"query","description":"The uri associated with the user","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/availability/list-user-busy-times","api_endpoint":"https://api.calendly.com/user_busy_times"},"summary":"List User Busy Times","description":"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>","security":[{"bearerAuth":[]}]}},"/contacts":{"post":{"tags":["Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/contacts/create-contact","api_endpoint":"https://api.calendly.com/contacts"},"summary":"Create Contact","description":"Create a new Contact <Info title=\"Required scopes\"> > `contacts:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"city":{"type":"string","description":"City"},"company":{"type":"string","description":"Company"},"country":{"type":"string","description":"Country"},"custom_fields":{"type":"array","description":"Custom field values to set on the contact. Each item requires a `uuid` (the custom field definition identifier) and a `value`; any other keys (such as `label`) are ignored. The entire request is rejected if any `uuid` is unknown, any `value` is the wrong type for its field (including an array for a scalar field or a scalar for an array field), or any `single_select` `value` is not one of the field definition's option `uuid`s.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the custom field definition.","required":true},"value":{"type":"string","description":"The custom field value; the accepted type is set by the field definition's `field_type`. `text` and `single_select` take a string (`single_select` must equal one of the definition's option `uuid`s); `number` takes a number; `boolean` takes a boolean; `currency` takes an integer amount in the currency's minor units (the ISO currency code lives on the field definition, not on this entry); `date` takes a string in ISO 8601 date format (`YYYY-MM-DD`); `tags` takes an array of strings. Scalar fields reject array values, and `tags` rejects non-array values.","required":true}}}},"emails":{"type":"array","description":"The user's email addresses. Max 10.","required":true,"items":{"type":"object","properties":{"email":{"type":"string","description":"Email address.","required":true},"is_primary":{"type":"boolean","description":"Whether this is the primary email.","required":true,"enum":[true,false]}}}},"job_title":{"type":"string","description":"Job Title"},"linkedin":{"type":"string","description":"Linkedin"},"name":{"type":"string","description":"Name","required":true},"phone_numbers":{"type":"array","description":"The user's phone numbers. Max 10.","items":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number.","required":true}}}},"state":{"type":"string","description":"State"},"timezone":{"type":"string","description":"Timezone"}}},"example":{"city":"","company":"","country":"","custom_fields":[],"emails":[],"job_title":"","linkedin":"","name":"","phone_numbers":[],"state":"","timezone":""}}}}},"get":{"tags":["Contacts"],"parameters":[{"name":"city","in":"query","description":"Filter results by partial match on city(ies). Accepts a comma-separated list-- each segment is matched independently (commas in the query string separate values).","required":false,"schema":{"type":"string","example":""}},{"name":"company","in":"query","description":"Filter results by partial match on company name(s). Accepts a comma-separated list-- each segment is matched independently (commas in the query string separate values).","required":false,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"country","in":"query","description":"Filter results by exact match on two-letter country code (ISO 3166-1 alpha-2). Accepts a comma-separated list.","required":false,"schema":{"type":"string","example":""}},{"name":"email","in":"query","description":"Filter results by exact match on email address. Accepts a comma-separated list.","required":false,"schema":{"type":"string","example":""}},{"name":"exclude","in":"query","description":"Omit the listed fields from the response. Currently only `custom_fields` is supported. When omitted, all fields are returned.","required":false,"schema":{"type":"string","example":""}},{"name":"job_title","in":"query","description":"Filter results by partial match on job title(s). Accepts a comma-separated list-- each segment is matched independently (commas in the query string separate values).","required":false,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"Filter results by partial match on name(s). Accepts a comma-separated list-- each segment is matched independently (commas in the query string separate values).","required":false,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"phone_number","in":"query","description":"Filter results by exact match on phone number. Accepts a comma-separated list.","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at, updated_at. Sort direction is specified as: asc, desc.","required":false,"schema":{"type":"string","example":""}},{"name":"state","in":"query","description":"Filter results by exact match on state(s), province(s), or region(s). Accepts a comma-separated list of values.","required":false,"schema":{"type":"string","example":""}},{"name":"timezone","in":"query","description":"Filter results by exact match on the IANA time zone name(s). Accepts a comma-separated list of time zones.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/contacts/list-contacts","api_endpoint":"https://api.calendly.com/contacts"},"summary":"List Contacts","description":"Returns a collection of Contacts <Info title=\"Required scopes\"> > `contacts:read` </Info>","security":[{"bearerAuth":[]}]}},"/contacts/{uuid}":{"delete":{"tags":["Contacts"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/contacts/delete-contacts-uuid","api_endpoint":"https://api.calendly.com/contacts/{uuid}"},"summary":"Delete Contact","description":"Delete an existing Contact <Info title=\"Required scopes\"> > `contacts:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Contacts"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}},{"name":"exclude","in":"query","description":"Omit the listed fields from the response. Currently only `custom_fields` is supported. When omitted, all fields are returned.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/contacts/get-contact","api_endpoint":"https://api.calendly.com/contacts/{uuid}"},"summary":"Get Contact","description":"Returns the details of a specified Contact. <Info title=\"Required scopes\"> > `contacts:read` </Info>","security":[{"bearerAuth":[]}]},"patch":{"tags":["Contacts"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/contacts/patch-contacts-uuid","api_endpoint":"https://api.calendly.com/contacts/{uuid}"},"summary":"Update Contact","description":"Update an existing Contact. The body must include at least one supported field; unknown top-level properties are rejected. <Info title=\"Required scopes\"> > `contacts:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"city":{"type":"string","description":"City"},"company":{"type":"string","description":"Company"},"country":{"type":"string","description":"Country"},"custom_fields":{"type":"array","description":"Custom field values to set on the contact. Each item requires a `uuid` (the custom field definition identifier) and a `value`; any other keys (such as `label`) are ignored. The entire request is rejected if any `uuid` is unknown, any `value` is the wrong type for its field (including an array for a scalar field or a scalar for an array field), or any `single_select` `value` is not one of the field definition's option `uuid`s.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the custom field definition.","required":true},"value":{"type":"string","description":"The custom field value; the accepted type is set by the field definition's `field_type`. `text` and `single_select` take a string (`single_select` must equal one of the definition's option `uuid`s); `number` takes a number; `boolean` takes a boolean; `currency` takes an integer amount in the currency's minor units (the ISO currency code lives on the field definition, not on this entry); `date` takes a string in ISO 8601 date format (`YYYY-MM-DD`); `tags` takes an array of strings. Scalar fields reject array values, and `tags` rejects non-array values.","required":true}}}},"emails":{"type":"array","description":"The user's email addresses. Max 10. <br> <span style=\"color:red\">Warning: </span>Updating emails will overwrite all existing emails for the contact. Use the GET endpoint to first retrieve the existing emails and then pass the modified emails to the emails array.","items":{"type":"object","properties":{"email":{"type":"string","description":"Email address.","required":true},"is_primary":{"type":"boolean","description":"Whether this is the primary email.","required":true,"enum":[true,false]}}}},"job_title":{"type":"string","description":"Job Title"},"linkedin":{"type":"string","description":"Linkedin"},"name":{"type":"string","description":"Name"},"phone_numbers":{"type":"array","description":"The user's phone numbers. Max 10. <br> <span style=\"color:red\">Warning: </span>Updating phone_numbers will overwrite all existing phone numbers for the contact. Use the GET endpoint to first retrieve the existing phone numbers and then pass the modified phone_numbers to the phone_numbers array.","items":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number.","required":true}}}},"state":{"type":"string","description":"State"},"timezone":{"type":"string","description":"Timezone"}}},"example":{"city":"","company":"","country":"","custom_fields":[],"emails":[],"job_title":"","linkedin":"","name":"","phone_numbers":[],"state":"","timezone":""}}}}}},"/contacts/custom_field_definitions/{uuid}":{"get":{"tags":["Contacts"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/contacts/get-contact-custom-field-definition","api_endpoint":"https://api.calendly.com/contacts/custom_field_definitions/{uuid}"},"summary":"Get Contact Custom Field Definition","description":"Returns a single custom field definition by uuid. <Info title=\"Required scopes\"> > `contacts:read` </Info>","security":[{"bearerAuth":[]}]}},"/contacts/custom_field_definitions":{"get":{"tags":["Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/contacts/list-contact-custom-field-definitions","api_endpoint":"https://api.calendly.com/contacts/custom_field_definitions"},"summary":"List Contact Custom Field Definitions","description":"Returns all custom field definitions available to the authenticated user or organization. <Info title=\"Required scopes\"> > `contacts:read` </Info>","security":[{"bearerAuth":[]}]}},"/data_compliance/deletion/invitees":{"post":{"tags":["Data Compliance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/data-compliance/delete-invitee-data","api_endpoint":"https://api.calendly.com/data_compliance/deletion/invitees"},"summary":"Delete Invitee Data","description":"To submit a request to remove invitee data from all previously booked events in your organization, use this endpoint. Requests for data deletion can take up to 7 days to complete. <Info> > This endpoint requires an <strong>Enterprise</strong> subscription. </Info> <Info title=\"Required scopes\"> > `data_compliance:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Emails","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}}},"/data_compliance/deletion/events":{"post":{"tags":["Data Compliance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/data-compliance/delete-scheduled-event-data","api_endpoint":"https://api.calendly.com/data_compliance/deletion/events"},"summary":"Delete Scheduled Event Data","description":"<Info> > This endpoint requires an <strong>Enterprise</strong> subscription. </Info> <Info title=\"Required scopes\"> > `data_compliance:write` </Info> To submit a request to remove scheduled events data within a time range for your organization, use this endpoint. Requests for data deletion can take up to 7 days to complete. Time range can be no greater than 24 months and must occur in the past.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"end_time":{"type":"string","description":"The scheduled events UTC timestamp at which data deletion should end. (ISO 8601 date-time)","required":true},"start_time":{"type":"string","description":"The scheduled events UTC timestamp at which data deletion should begin. (ISO 8601 date-time)","required":true}}},"example":{"end_time":"","start_time":""}}}}}},"/event_types":{"post":{"tags":["Event Types"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/event-types/create-event-type","api_endpoint":"https://api.calendly.com/event_types"},"summary":"Create Event Type","description":"Create a new Event Type **NOTE:** * Currently, this endpoint only supports one-on-one event types (kind: \"solo\"). <Info title=\"Required scopes\"> > `event_types:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Indicates if the event type is active or not","enum":[true,false]},"color":{"type":"string","description":"The hexadecimal color value of the event type's scheduling page"},"description":{"type":"string","description":"The event type description"},"duration":{"type":"number","description":"The length of sessions booked with this event type. Must be one of the duration options if they're provided."},"duration_options":{"type":"array","description":"A maximum of 4 unique options is allowed. Each option must be >= 1 and <= 720.","items":{"type":"number"}},"locale":{"type":"string","description":"The locale on the event type, used to determine the language of the event type's scheduling page","enum":["de","en","es","fr","it","nl","pt","uk"]},"locations":{"type":"array","description":"Configuration information for each possible location for this event type","items":{"type":"object","properties":{"additional_info":{"type":"string","description":"Additional Info"},"kind":{"type":"string","description":"Kind","enum":["ask_invitee","custom","google_conference","gotomeeting_conference","inbound_call","microsoft_teams_conference","outbound_call","physical","webex_conference","zoom_conference"]},"location":{"type":"string","description":"Location"},"phone_number":{"type":"string","description":"Phone Number"}}}},"name":{"type":"string","description":"The event type name","required":true},"owner":{"type":"string","description":"The owner for this event type","required":true}}},"example":{"active":"","color":"","description":"","duration":"","duration_options":[],"locale":"","locations":[],"name":"","owner":""}}}}},"get":{"tags":["Event Types"],"parameters":[{"name":"active","in":"query","description":"Return only active event types if true, only inactive if false, or all event types if this parameter is omitted.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"admin_managed","in":"query","description":"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.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"organization","in":"query","description":"View available personal, team, and organization event types associated with the organization's URI.","required":false,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"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.","required":false,"schema":{"type":"string","example":""}},{"name":"user","in":"query","description":"View available personal, team, and organization event types associated with the user's URI.","required":false,"schema":{"type":"string","example":""}},{"name":"user_availability_schedule","in":"query","description":"Used in conjunction with `user` parameter, returns a filtered list of Event Types that use the given primary availability schedule.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/event-types/list-event-types","api_endpoint":"https://api.calendly.com/event_types"},"summary":"List User's Event Types","description":"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>","security":[{"bearerAuth":[]}]}},"/one_off_event_types":{"post":{"tags":["Event Types"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/event-types/create-one-off-event-type","api_endpoint":"https://api.calendly.com/one_off_event_types"},"summary":"Create One-Off Event Type","description":"Creates One-Off Event Type <Info title=\"Required scopes\"> > `event_types:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"co_hosts":{"type":"array","description":"Collection of meeting co-host(s) user URIs","items":{"type":"string"}},"date_setting":{"type":"string","description":"Date Setting","required":true},"duration":{"type":"number","description":"Duration of meeting in minutes","required":true},"host":{"type":"string","description":"Host user uri","required":true},"location":{"type":"string","description":"Location"},"name":{"type":"string","description":"Event type name","required":true},"timezone":{"type":"string","description":"Time zone used for meeting. Defaults to host's time zone."}}},"example":{"co_hosts":[],"date_setting":"","duration":"","host":"","location":"","name":"","timezone":""}}}}}},"/event_types/{uuid}":{"get":{"tags":["Event Types"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/event-types/get-event-type","api_endpoint":"https://api.calendly.com/event_types/{uuid}"},"summary":"Get Event Type","description":"Returns information about a specified Event Type. <Info title=\"Required scopes\"> > `event_types:read` </Info>","security":[{"bearerAuth":[]}]},"patch":{"tags":["Event Types"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/event-types/update-event-type","api_endpoint":"https://api.calendly.com/event_types/{uuid}"},"summary":"Update Event Type","description":"Update an existing Event Type **NOTE:** * Currently, this endpoint only supports one-on-one event types (kind: \"solo\"). <Info title=\"Required scopes\"> > `event_types:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Indicates if the event type is active or not","enum":[true,false]},"color":{"type":"string","description":"The hexadecimal color value of the event type's scheduling page"},"description":{"type":"string","description":"The event type description"},"duration":{"type":"number","description":"The length of sessions booked with this event type. Must be one of the duration options if they're provided."},"duration_options":{"type":"array","description":"A maximum of 4 unique options is allowed. Each option must be >= 1 and <= 720.","items":{"type":"number"}},"locale":{"type":"string","description":"The locale on the event type, used to determine the language of the event type's scheduling page","enum":["de","en","es","fr","it","nl","pt","uk"]},"locations":{"type":"array","description":"Configuration information for each possible location for this Event Type","items":{"type":"object","properties":{"additional_info":{"type":"string","description":"Additional Info"},"kind":{"type":"string","description":"Kind","enum":["ask_invitee","custom","google_conference","gotomeeting_conference","inbound_call","microsoft_teams_conference","outbound_call","physical","webex_conference","zoom_conference"]},"location":{"type":"string","description":"Location"},"phone_number":{"type":"string","description":"Phone Number"}}}},"name":{"type":"string","description":"The event type name"}}},"example":{"active":"","color":"","description":"","duration":"","duration_options":[],"locale":"","locations":[],"name":""}}}}}},"/event_type_available_times":{"get":{"tags":["Event Types"],"parameters":[{"name":"end_time","in":"query","description":"End time of the requested availability range. Date must be in the future and no greater than 31 days from start_time.","required":true,"schema":{"type":"string","example":""}},{"name":"event_type","in":"query","description":"The uri associated with the event type","required":true,"schema":{"type":"string","example":""}},{"name":"start_time","in":"query","description":"Start time of the requested availability range. Date cannot be in the past.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/event-types/list-event-type-available-times","api_endpoint":"https://api.calendly.com/event_type_available_times"},"summary":"List Event Type Available Times","description":"Returns a list of available times for an event type within a specified date range. **NOTE:** * Date range can be no greater than 31 days. * This endpoint does not support traditional keyset pagination. <Info title=\"Required scopes\"> > `availability:read` </Info>","security":[{"bearerAuth":[]}]}},"/event_type_memberships":{"get":{"tags":["Event Types"],"parameters":[{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"event_type","in":"query","description":"The uri associated with the event type","required":true,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/event-types/list-event-type-memberships","api_endpoint":"https://api.calendly.com/event_type_memberships"},"summary":"List Event Type Hosts","description":"Fetch list of event type hosts <Info title=\"Required scopes\"> > `event_types:read` </Info>","security":[{"bearerAuth":[]}]}},"/groups/{uuid}":{"get":{"tags":["Groups"],"parameters":[{"name":"uuid","in":"path","description":"Group unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/groups/get-group","api_endpoint":"https://api.calendly.com/groups/{uuid}"},"summary":"Get Group","description":"Returns information about a specified Group. <Info title=\"Required scopes\"> > `groups:read` </Info>","security":[{"bearerAuth":[]}]}},"/group_relationships/{uuid}":{"get":{"tags":["Groups"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/groups/get-group-relationship","api_endpoint":"https://api.calendly.com/group_relationships/{uuid}"},"summary":"Get Group Relationship","description":"Returns a group relationship by uuid <Info title=\"Required scopes\"> > `groups:read` </Info>","security":[{"bearerAuth":[]}]}},"/group_relationships":{"get":{"tags":["Groups"],"parameters":[{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"group","in":"query","description":"Indicates the results should be filtered by group","required":false,"schema":{"type":"string","example":""}},{"name":"organization","in":"query","description":"Indicates the results should be filtered by organization","required":false,"schema":{"type":"string","example":""}},{"name":"owner","in":"query","description":"Indicates the results should be filtered by owner <br> One Of: - Organization Membership URI - `https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA` - Organization Invitation URI - `https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB`","required":false,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/groups/list-group-relationships","api_endpoint":"https://api.calendly.com/group_relationships"},"summary":"List Group Relationships","description":"Returns a list of group relationships - a given owner can have one membership record, but multiple admin records <Info title=\"Required scopes\"> > `groups:read` </Info>","security":[{"bearerAuth":[]}]}},"/groups":{"get":{"tags":["Groups"],"parameters":[{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"organization","in":"query","description":"Return groups that are associated with the organization associated with this URI","required":true,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/groups/list-groups","api_endpoint":"https://api.calendly.com/groups"},"summary":"List Groups","description":"Returns a list of groups. <Info title=\"Required scopes\"> > `groups:read` </Info>","security":[{"bearerAuth":[]}]}},"/locations":{"get":{"tags":["Locations"],"parameters":[{"name":"user","in":"query","description":"The URI associated with the user","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/locations/list-user-locations","api_endpoint":"https://api.calendly.com/locations"},"summary":"List User Meeting Locations","description":"Returns configured location information for a given user. <Info title=\"Required scopes\"> > `locations:read` </Info>","security":[{"bearerAuth":[]}]}},"/meeting_recaps/{uuid}":{"delete":{"tags":["Notetaker"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/notetaker/delete-meeting-recaps-uuid","api_endpoint":"https://api.calendly.com/meeting_recaps/{uuid}"},"summary":"Delete Recap","description":"Delete an existing Recap **Note:** Requires paid plan <Info title=\"Required scopes\"> > `meeting_recaps:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Notetaker"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/notetaker/get-meeting-recaps-uuid-recap","api_endpoint":"https://api.calendly.com/meeting_recaps/{uuid}"},"summary":"Get Recap","description":"Returns the recap associated with a meeting if it is available. **Note:** Requires paid plan <Info title=\"Required scopes\"> > `meeting_recaps:read` </Info>","security":[{"bearerAuth":[]}]},"patch":{"tags":["Notetaker"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/notetaker/update-meeting-recaps-uuid","api_endpoint":"https://api.calendly.com/meeting_recaps/{uuid}"},"summary":"Update Recap","description":"Update an existing Recap. You may send any combination of the optional body fields; omitted fields are left unchanged. Unknown top-level properties are rejected. **Note:** Requires paid plan <Info title=\"Required scopes\"> > `meeting_recaps:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action_items_md":{"type":"string","description":"Action items in Markdown."},"discussion_md":{"type":"string","description":"Discussion notes in Markdown."},"summary_md":{"type":"string","description":"Summary in Markdown."}}},"example":{"action_items_md":"","discussion_md":"","summary_md":""}}}}}},"/meeting_recaps/{uuid}/transcript":{"get":{"tags":["Notetaker"],"parameters":[{"name":"uuid","in":"path","description":"The meeting recap uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/notetaker/get-transcript-meeting-recaps","api_endpoint":"https://api.calendly.com/meeting_recaps/{uuid}/transcript"},"summary":"Get Transcript","description":"Returns the transcript associated with a meeting recap if it is available. **Note:** Requires paid plan <Info title=\"Required scopes\"> > `meeting_recaps:read` </Info>","security":[{"bearerAuth":[]}]}},"/meeting_recaps":{"get":{"tags":["Notetaker"],"parameters":[{"name":"attendee","in":"query","description":"Filter results to recaps that include a specific attendee email address.","required":false,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"end_time","in":"query","description":"Return recaps for meetings that start before (or start at) this time (ISO 8601).","required":false,"schema":{"type":"string","example":""}},{"name":"event","in":"query","description":"Filter results to recaps associated with a specific event scheduled via Calendly. This field corresponds to the `/scheduled_events` endpoint.","required":false,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"start_time","in":"query","description":"Return recaps for meetings that end after (or end at) this time (ISO 8601).","required":false,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"Filter by recap availability. When omitted, returns **Available** recaps only. - `available` — completed recaps with summary content - `processing` — recaps still being generated - `unavailable` — recaps that cannot be retrieved","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["available","processing","unavailable"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/notetaker/list-meeting-recaps","api_endpoint":"https://api.calendly.com/meeting_recaps"},"summary":"List Recaps","description":"Returns a paginated list of meeting recaps accessible to the authenticated user. By default, returns **Available** recaps only. Use the `status` query parameter to retrieve `processing` or `unavailable` recaps. Supports additional filtering by scheduled event, attendee, or date range. Returns both Calendly-scheduled and external event recaps in a single collection. The `event` field is null for external events where no Calendly scheduled event exists. **Note:** Requires paid plan <Info title=\"Required scopes\"> > `meeting_recaps:read` </Info>","security":[{"bearerAuth":[]}]}},"/organizations/{uuid}":{"get":{"tags":["Organizations"],"parameters":[{"name":"uuid","in":"path","description":"The organization's unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/organizations/get-organization","api_endpoint":"https://api.calendly.com/organizations/{uuid}"},"summary":"Get Organization","description":"Returns the details of a specified Organization. <Info title=\"Required scopes\"> > `organizations:read` </Info>","security":[{"bearerAuth":[]}]}},"/organizations/{org_uuid}/invitations/{uuid}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org_uuid","in":"path","description":"The organization’s unique identifier","required":true,"schema":{"type":"string","example":""}},{"name":"uuid","in":"path","description":"The organization invitation's unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/organizations/get-organization-invitation","api_endpoint":"https://api.calendly.com/organizations/{org_uuid}/invitations/{uuid}"},"summary":"Get Organization Invitation","description":"Returns an Organization Invitation that was sent to the organization's members. <Info title=\"Required scopes\"> > `organizations:read` </Info>","security":[{"bearerAuth":[]}]},"delete":{"tags":["Organizations"],"parameters":[{"name":"org_uuid","in":"path","description":"The organization’s unique identifier","required":true,"schema":{"type":"string","example":""}},{"name":"uuid","in":"path","description":"The organization invitation's unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/organizations/revoke-organization-invitation","api_endpoint":"https://api.calendly.com/organizations/{org_uuid}/invitations/{uuid}"},"summary":"Revoke User's Organization Invitation","description":"Use this to revoke an Organization Invitation to an organization. Once revoked, the invitation link that was sent to the invitee is no longer valid. <Info title=\"Required scopes\"> > `organizations:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/organization_memberships/{uuid}":{"get":{"tags":["Organizations"],"parameters":[{"name":"uuid","in":"path","description":"The organization membership's unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/organizations/get-organization-membership","api_endpoint":"https://api.calendly.com/organization_memberships/{uuid}"},"summary":"Get Organization Membership","description":"Returns information about a user's Organization Membership <Info title=\"Required scopes\"> > `organizations:read` </Info>","security":[{"bearerAuth":[]}]},"delete":{"tags":["Organizations"],"parameters":[{"name":"uuid","in":"path","description":"The organization membership's unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/organizations/delete-organization-membership","api_endpoint":"https://api.calendly.com/organization_memberships/{uuid}"},"summary":"Remove User from Organization","description":"Removes a user from an organization. Notes: * To remove users, the caller must have admin rights for the organization * An organization owner can't be removed <Info title=\"Required scopes\"> > `organizations:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/organizations/{uuid}/invitations":{"post":{"tags":["Organizations"],"parameters":[{"name":"uuid","in":"path","description":"The organization's unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/organizations/create-organization-invitation","api_endpoint":"https://api.calendly.com/organizations/{uuid}/invitations"},"summary":"Invite User to Organization","description":"Invites a user to an organization. <Info title=\"Required scopes\"> > `organizations:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The email of the user being invited","required":true}}},"example":{"email":""}}}}},"get":{"tags":["Organizations"],"parameters":[{"name":"uuid","in":"path","description":"The organization's unique identifier","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"email","in":"query","description":"Indicates if the results should be filtered by email address","required":false,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Order results by the field name and direction specified (ascending or descending). Returns multiple sets of results in a comma-separated list.","required":false,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"Indicates if the results should be filtered by status (\"pending\", \"accepted\", or \"declined\")","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["pending","accepted","declined"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/organizations/list-organization-invitations","api_endpoint":"https://api.calendly.com/organizations/{uuid}/invitations"},"summary":"List Organization Invitations","description":"Returns a list of Organization Invitations that were sent to the organization's members. <Info title=\"Required scopes\"> > `organizations:read` </Info>","security":[{"bearerAuth":[]}]}},"/organization_memberships":{"get":{"tags":["Organizations"],"parameters":[{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"email","in":"query","description":"Indicates if the results should be filtered by email address","required":false,"schema":{"type":"string","example":""}},{"name":"organization","in":"query","description":"Indicates if the results should be filtered by organization","required":false,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"role","in":"query","description":"Indicates if the results should be filtered by role","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["owner","admin","user"]}}},{"name":"user","in":"query","description":"Indicates if the results should be filtered by user","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/organizations/list-organization-memberships","api_endpoint":"https://api.calendly.com/organization_memberships"},"summary":"List Organization Memberships","description":"Use this to list the Organization Memberships for all users belonging to an organization, use: * `user` to look up a user's membership in an organization * `organization` to look up all users that belong to the organization This endpoint can also be used to retrieve your organization URI. <Info title=\"Required scopes\"> > `organizations:read` </Info>","security":[{"bearerAuth":[]}]}},"/outgoing_communications":{"get":{"tags":["Outgoing Communications"],"parameters":[{"name":"count","in":"query","description":"The number of records to return","required":false,"schema":{"type":"number","example":""}},{"name":"max_created_at","in":"query","description":"Include outgoing communications that were created prior to this time (sample time format: \"2020-01-02T03:04:05.678Z\"). This time should use the UTC timezone","required":false,"schema":{"type":"string","example":""}},{"name":"min_created_at","in":"query","description":"Include outgoing communications that were created after this time (sample time format: \"2020-01-02T03:04:05.678Z\"). This time should use the UTC timezone","required":false,"schema":{"type":"string","example":""}},{"name":"organization","in":"query","description":"Return outgoing communications from the organization associated with this URI","required":true,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next portion of the collection","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/outgoing-communications/list-outgoing-communications","api_endpoint":"https://api.calendly.com/outgoing_communications"},"summary":"List outgoing communications","description":"<Info> > This endpoint requires an <strong>Enterprise</strong> subscription. </Info> <Info title=\"Required scopes\"> > `outgoing_communications:read` </Info> Returns a list of outgoing SMS and email communications.","security":[{"bearerAuth":[]}]}},"/routing_forms/{uuid}":{"get":{"tags":["Routing Forms"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/routing-forms/get-routing-form","api_endpoint":"https://api.calendly.com/routing_forms/{uuid}"},"summary":"Get Routing Form","description":"Get a specified Routing Form. <Info title=\"Required scopes\"> > `routing_forms:read` </Info>","security":[{"bearerAuth":[]}]}},"/routing_form_submissions/{uuid}":{"get":{"tags":["Routing Forms"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/routing-forms/get-routing-form-submission","api_endpoint":"https://api.calendly.com/routing_form_submissions/{uuid}"},"summary":"Get Routing Form Submission","description":"Get a specified Routing Form Submission. <Info title=\"Required scopes\"> > `routing_forms:read` </Info>","security":[{"bearerAuth":[]}]}},"/routing_form_submissions":{"get":{"tags":["Routing Forms"],"parameters":[{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"form","in":"query","description":"View routing form submissions associated with the routing form's URI.","required":true,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/routing-forms/list-routing-form-submissions","api_endpoint":"https://api.calendly.com/routing_form_submissions"},"summary":"List Routing Form Submissions","description":"Get a list of Routing Form Submissions for a specified Routing Form. <Info title=\"Required scopes\"> > `routing_forms:read` </Info>","security":[{"bearerAuth":[]}]}},"/routing_forms":{"get":{"tags":["Routing Forms"],"parameters":[{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"organization","in":"query","description":"View organization routing forms associated with the organization's URI.","required":true,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/routing-forms/list-routing-forms","api_endpoint":"https://api.calendly.com/routing_forms"},"summary":"List Routing Forms","description":"Get a list of Routing Forms for a specified Organization. <Info title=\"Required scopes\"> > `routing_forms:read` </Info>","security":[{"bearerAuth":[]}]}},"/scheduled_events/{uuid}/cancellation":{"post":{"tags":["Scheduled Events"],"parameters":[{"name":"uuid","in":"path","description":"The event's unique indentifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/create-scheduled-event-cancellation","api_endpoint":"https://api.calendly.com/scheduled_events/{uuid}/cancellation"},"summary":"Cancel Event","description":"Cancels specified event. <Info title=\"Required scopes\"> > `scheduled_events:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"reason":{"type":"string","description":"Reason for cancellation"}}},"example":{"reason":""}}}}}},"/invitees":{"post":{"tags":["Scheduled Events"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/create-event-invitee","api_endpoint":"https://api.calendly.com/invitees"},"summary":"Create Event Invitee (Scheduling API)","description":"Creates a new booking for an event invitee. Use this endpoint to book an invitee directly from your app without redirects, iframes, or Calendly-hosted UI. Standard notifications, calendar invites, reschedules, and workflows run as if booked via the Calendly UI. **NOTE:** * Access to this endpoint is limited to Calendly users on paid plans (Standard and above). Users on the Free plan will receive a 403 Forbidden response. <Info title=\"Required scopes\"> > `scheduled_events:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"event_guests":{"type":"array","description":"Emails of invitee guests. Max 10.","items":{"type":"string"}},"event_type":{"type":"string","description":"Canonical reference (unique identifier) for the event type being scheduled","required":true},"invitee":{"type":"object","description":"Invitee","required":true,"properties":{"email":{"type":"string","description":"The email of the invitee","required":true},"first_name":{"type":"string","description":"The first name of the invitee. **Required if** `name` **is not provided**"},"last_name":{"type":"string","description":"The last name of the invitee"},"name":{"type":"string","description":"The full name of the invitee. **Required if** `first_name` **is not provided**"},"text_reminder_number":{"type":"string","description":"Invitee's phone number for SMS reminders. Must be a valid phone number (e.g. +14155551234)"},"timezone":{"type":"string","description":"The timezone of the invitee","required":true}}},"location":{"type":"string","description":"The polymorphic base type for an event location that Calendly supports. Note: - Location.kind must be supplied if location is defined. - Location must match location specified on the EventType. - Do not pass the location object for an EventType with a round_robin pooling_type."},"questions_and_answers":{"type":"array","description":"Questions And Answers","items":{"type":"object","properties":{"answer":{"type":"string","description":"The invitee's response to the question","required":true},"position":{"type":"number","description":"The position of the question in relation to others","required":true},"question":{"type":"string","description":"A question for the invitee. String is case sensitive and must exactly match the question.","required":true}}}},"start_time":{"type":"string","description":"The start time in UTC of the scheduled event (ISO 8601 date-time)","required":true},"tracking":{"type":"object","description":"The UTM and Salesforce tracking parameters associated with an Invitee","properties":{"salesforce_uuid":{"type":"string","description":"The Salesforce record unique identifier","required":true},"utm_campaign":{"type":"string","description":"The UTM parameter used to track a campaign","required":true},"utm_content":{"type":"string","description":"UTM content tracking parameter","required":true},"utm_medium":{"type":"string","description":"The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social media, affiliate or QR code)","required":true},"utm_source":{"type":"string","description":"The UTM parameter that identifies the source (platform where the traffic originates)","required":true},"utm_term":{"type":"string","description":"The UTM parameter used to track keywords","required":true}}}}},"example":{"event_guests":[],"event_type":"","invitee":{},"location":"","questions_and_answers":[],"start_time":"","tracking":{}}}}}}},"/invitee_no_shows":{"post":{"tags":["Scheduled Events"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/create-invitee-no-show","api_endpoint":"https://api.calendly.com/invitee_no_shows"},"summary":"Create Invitee No Show","description":"Marks an Invitee as a No Show. <Info title=\"Required scopes\"> > `scheduled_events:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"invitee":{"type":"string","description":"Invitee"}}},"example":{"invitee":""}}}}}},"/invitee_no_shows/{uuid}":{"delete":{"tags":["Scheduled Events"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/delete-invitee-no-show","api_endpoint":"https://api.calendly.com/invitee_no_shows/{uuid}"},"summary":"Delete Invitee No Show","description":"Undoes marking an Invitee as a No Show. <Info title=\"Required scopes\"> > `scheduled_events:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Scheduled Events"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/get-invitee-no-show","api_endpoint":"https://api.calendly.com/invitee_no_shows/{uuid}"},"summary":"Get Invitee No Show","description":"Returns information about a specified Invitee No Show. <Info title=\"Required scopes\"> > `scheduled_events:read` </Info>","security":[{"bearerAuth":[]}]}},"/scheduled_events/{uuid}":{"get":{"tags":["Scheduled Events"],"parameters":[{"name":"uuid","in":"path","description":"The event's unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/get-scheduled-event","api_endpoint":"https://api.calendly.com/scheduled_events/{uuid}"},"summary":"Get Event","description":"Returns information about a specified Event. <Info title=\"Required scopes\"> > `scheduled_events:read` </Info>","security":[{"bearerAuth":[]}]}},"/scheduled_events/{event_uuid}/invitees/{invitee_uuid}":{"get":{"tags":["Scheduled Events"],"parameters":[{"name":"event_uuid","in":"path","description":"The event's unique identifier","required":true,"schema":{"type":"string","example":""}},{"name":"invitee_uuid","in":"path","description":"The invitee's unique identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/get-event-invitee","api_endpoint":"https://api.calendly.com/scheduled_events/{event_uuid}/invitees/{invitee_uuid}"},"summary":"Get Event Invitee","description":"Returns information about a specified Invitee (person invited to an event). <Info title=\"Required scopes\"> > `scheduled_events:read` </Info>","security":[{"bearerAuth":[]}]}},"/scheduled_events/{uuid}/invitees":{"get":{"tags":["Scheduled Events"],"parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"email","in":"query","description":"Indicates if the results should be filtered by email address","required":false,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Order results by the **created_at** field and direction specified: ascending (\"asc\") or descending (\"desc\")","required":false,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"Indicates if the invitee \"canceled\" or still \"active\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["active","canceled"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/list-event-invitees","api_endpoint":"https://api.calendly.com/scheduled_events/{uuid}/invitees"},"summary":"List Event Invitees","description":"Returns a list of Invitees for an event. <Info title=\"Required scopes\"> > `scheduled_events:read` </Info>","security":[{"bearerAuth":[]}]}},"/scheduled_events":{"get":{"tags":["Scheduled Events"],"parameters":[{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"group","in":"query","description":"Return events that are scheduled with the group associated with this URI","required":false,"schema":{"type":"string","example":""}},{"name":"invitee_email","in":"query","description":"Return events that are scheduled with the invitee associated with this email address","required":false,"schema":{"type":"string","example":""}},{"name":"max_start_time","in":"query","description":"Include events with start times prior to this time (sample time format: \"2020-01-02T03:04:05.678123Z\"). This time should use the UTC timezone.","required":false,"schema":{"type":"string","example":""}},{"name":"min_start_time","in":"query","description":"Include events with start times after this time (sample time format: \"2020-01-02T03:04:05.678123Z\"). This time should use the UTC timezone.","required":false,"schema":{"type":"string","example":""}},{"name":"organization","in":"query","description":"Return events that are scheduled with the organization associated with this URI","required":false,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: start_time. Sort direction is specified as: asc, desc.","required":false,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"Whether the scheduled event is `active` or `canceled`","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["active","canceled"]}}},{"name":"user","in":"query","description":"Return events that are scheduled with the user associated with this URI","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduled-events/list-scheduled-events","api_endpoint":"https://api.calendly.com/scheduled_events"},"summary":"List Events","description":"Returns a list of Events. * Pass `organization` parameter to return events for that organization (requires admin/owner privilege) * Pass `user` parameter to return events for a specific User * Pass `group` parameter to return events for a specific Group (requires organization admin/owner or group admin privilege) **NOTES:** * If you are the admin/owner of the organization, you can use both `organization` and `user` to get a list of events for a specific user within your organization. * If you are the admin/owner of the organization, you can use both `organization` and `group` to get a list of events for a specific group within your organization. * `user` can only be used alone when requesting your own personal events. This will return your events within any organization that you are currently in or were a part of in the past. <Info title=\"Required scopes\"> > `scheduled_events:read` </Info>","security":[{"bearerAuth":[]}]}},"/scheduling_links":{"post":{"tags":["Scheduling Links"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/scheduling-links/create-scheduling-link","api_endpoint":"https://api.calendly.com/scheduling_links"},"summary":"Create Single-Use Scheduling Link","description":"Creates a single-use scheduling link. <Info title=\"Required scopes\"> > `scheduling_links:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_event_count":{"type":"string","description":"The max number of events that can be scheduled using this scheduling link.","required":true,"enum":["1"]},"owner":{"type":"string","description":"A link to the resource that owns this Scheduling Link (currently, this is always an Event Type)","required":true},"owner_type":{"type":"string","description":"Resource type (currently, this is always EventType)","required":true,"enum":["EventType"]}}},"example":{"max_event_count":"","owner":"","owner_type":""}}}}}},"/shares":{"post":{"tags":["Shares"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/shares/create-share","api_endpoint":"https://api.calendly.com/shares"},"summary":"Create Share","description":"Endpoint for our [Customize Once and Share](https://calendly.com/help/how-to-create-a-single-use-link) feature. This allows you to customize events for a specific invitee without needing to make an entirely new event type. ***This feature is only available for one-on-one event types.*** **Note: Any parameter which is not provided in the request body will be copied from the target event type.** <Info title=\"Required scopes\"> > `shares:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"availability_rule":{"type":"object","description":"Availability Rule","properties":{"rules":{"type":"array","description":"are required when an availability rule is provided"},"timezone":{"type":"string","description":"is required when an availability rule is provided"}}},"duration":{"type":"number","description":"Must be one of the provided duration options. If duration options aren't provided then duration must be one of the duration options inherited from the event type."},"duration_options":{"type":"array","description":"A maximum of 4 unique options is allowed. Each option must be >= 1 and <= 720.","items":{"type":"number"}},"end_date":{"type":"string","description":"is required when `period_type` is 'fixed' Format: `YYYY-MM-DD`"},"event_type":{"type":"string","description":"Event Type","required":true},"hide_location":{"type":"boolean","description":"determines if a location is hidden until invitee books a spot, only respected when there is a single custom location configured","enum":[true,false]},"location_configurations":{"type":"array","description":"Location Configurations","items":{"type":"object","properties":{"additional_info":{"type":"string","description":"is only supported when `kind` is 'physical' or 'inbound_call'"},"kind":{"type":"string","description":"Kind","enum":["physical","ask_invitee","custom","outbound_call","inbound_call","google_conference","gotomeeting_conference","microsoft_teams_conference","webex_conference","zoom_conference"]},"location":{"type":"string","description":"is only supported when `kind` is 'physical', 'custom' or 'ask_invitee'"},"phone_number":{"type":"string","description":"is required when `kind` is 'inbound_call'"},"position":{"type":"number","description":"Position"}}}},"max_booking_time":{"type":"number","description":"is required when `period_type` is 'moving' or 'available_moving'"},"name":{"type":"string","description":"Name"},"period_type":{"type":"string","description":"Period Type","enum":["available_moving","moving","fixed","unlimited"]},"start_date":{"type":"string","description":"is required when `period_type` is 'fixed' Format: `YYYY-MM-DD`"}}},"example":{"availability_rule":{},"duration":"","duration_options":[],"end_date":"","event_type":"","hide_location":"","location_configurations":[],"max_booking_time":"","name":"","period_type":"","start_date":""}}}}}},"/users/me":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/users/get-current-user","api_endpoint":"https://api.calendly.com/users/me"},"summary":"Get current user","description":"Returns basic information about your user account. <Info title=\"Required scopes\"> > `users:read` </Info>","security":[{"bearerAuth":[]}]}},"/users/{uuid}":{"get":{"tags":["Users"],"parameters":[{"name":"uuid","in":"path","description":"User unique identifier, or the constant \"me\" to reference the caller","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/users/get-user","api_endpoint":"https://api.calendly.com/users/{uuid}"},"summary":"Get user","description":"Returns information about a specified User. <Info title=\"Required scopes\"> > `users:read` </Info>","security":[{"bearerAuth":[]}]}},"/webhook_subscriptions":{"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/webhooks/create-webhook-subscription","api_endpoint":"https://api.calendly.com/webhook_subscriptions"},"summary":"Create Webhook Subscription","description":"Create a Webhook Subscription for an Organization, User, or Group. * The `organization` subscription scope triggers the webhook for all subscribed events within the organization. * The `user` subscription scope only triggers the webhook for subscribed events that belong to the specific user. * The `group` subscription scope only triggers the webhook for subscribed events that belong to the specfic group. | Event | Allowed Subscription Scopes | Required Auth Scope | | ----- | ----- | ----- | | invitee.created | `organization` `user` `group` | `scheduled_events:read` | | invitee.canceled | `organization` `user` `group` | `scheduled_events:read` | | invitee_no_show.created | `organization` `user` `group` | `scheduled_events:read` | | invitee_no_show.deleted | `organization` `user` `group` | `scheduled_events:read` | | event_type.created | `organization` `user` `group` | `event_types:read` | | event_type.deleted | `organization` `user` `group` | `event_types:read` | | event_type.updated | `organization` `user` `group` | `event_types:read` | | meeting_recap.created | `user` | `meeting_recaps:read` | | meeting_recap.updated | `user` | `meeting_recaps:read` | | meeting_recap.deleted | `user` | `meeting_recaps:read` | | routing_form_submission.created | `organization` <br /> <small>Create separate Webhook Subscriptions for events with different subscription scopes.</small> | `routing_forms:read` | | contact.created | `organization` `user` `group` | `contacts:read` | | contact.updated | `organization` `user` `group` | `contacts:read` | | contact.deleted | `organization` `user` `group` | `contacts:read` | <Info title=\"Required scopes\"> > `webhooks:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"events":{"type":"array","description":"List of user events to subscribe to.","required":true,"items":{"type":"string"}},"group":{"type":"string","description":"The unique reference to the group that the webhook will be tied to."},"organization":{"type":"string","description":"The unique reference to the organization that the webhook will be tied to.","required":true},"scope":{"type":"string","description":"Indicates whether the webhook subscription scope is `organization`, `user`, or `group`","required":true,"enum":["organization","user","group"]},"signing_key":{"type":"string","description":"Optional secret key shared between your application and Calendly. See https://developer.calendly.com/api-docs/ZG9jOjM2MzE2MDM4-webhook-signatures for additional information."},"url":{"type":"string","description":"The URL where you want to receive POST requests for events you are subscribed to.","required":true},"user":{"type":"string","description":"The unique reference to the user that the webhook will be tied to."}}},"example":{"events":[],"group":"","organization":"","scope":"","signing_key":"","url":"","user":""}}}}},"get":{"tags":["Webhooks"],"parameters":[{"name":"count","in":"query","description":"The number of rows to return","required":false,"schema":{"type":"number","example":""}},{"name":"group","in":"query","description":"Indicates if the results should be filtered by group. This parameter is only required if the `scope` parameter is set to `group`.","required":false,"schema":{"type":"string","example":""}},{"name":"organization","in":"query","description":"The given organization that owns the subscriptions being returned. This field is always required.","required":true,"schema":{"type":"string","example":""}},{"name":"page_token","in":"query","description":"The token to pass to get the next or previous portion of the collection","required":false,"schema":{"type":"string","example":""}},{"name":"scope","in":"query","description":"Filter the list by organization, user, or group","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["organization","user","group"]}}},{"name":"sort","in":"query","description":"Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.","required":false,"schema":{"type":"string","example":""}},{"name":"user","in":"query","description":"Indicates if the results should be filtered by user. This parameter is only required if the `scope` parameter is set to `user`.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/webhooks/list-webhook-subscriptions","api_endpoint":"https://api.calendly.com/webhook_subscriptions"},"summary":"List Webhook Subscriptions","description":"Get a list of Webhook Subscriptions for a specified Organization, User, or Group. <Info title=\"Required scopes\"> > `webhooks:read` </Info>","security":[{"bearerAuth":[]}]}},"/webhook_subscriptions/{webhook_uuid}":{"delete":{"tags":["Webhooks"],"parameters":[{"name":"webhook_uuid","in":"path","description":"Webhook Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/webhooks/delete-webhook-subscription","api_endpoint":"https://api.calendly.com/webhook_subscriptions/{webhook_uuid}"},"summary":"Delete Webhook Subscription","description":"Delete a Webhook Subscription. <Info title=\"Required scopes\"> > `webhooks:write` </Info>","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Webhooks"],"parameters":[{"name":"webhook_uuid","in":"path","description":"Webhook Uuid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/webhooks/get-webhook-subscription","api_endpoint":"https://api.calendly.com/webhook_subscriptions/{webhook_uuid}"},"summary":"Get Webhook Subscription","description":"Get a specified Webhook Subscription. <Info title=\"Required scopes\"> > `webhooks:read` </Info>","security":[{"bearerAuth":[]}]}},"/sample_webhook_data":{"get":{"tags":["Webhooks"],"parameters":[{"name":"event","in":"query","description":"Event","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["invitee.created","invitee.canceled","invitee_no_show.created","invitee_no_show.deleted","routing_form_submission.created","event_type.created","event_type.deleted","event_type.updated","meeting_recap.created","meeting_recap.updated","meeting_recap.deleted","contact.created","contact.updated","contact.deleted"]}}},{"name":"group","in":"query","description":"Group","required":false,"schema":{"type":"string","example":""}},{"name":"organization","in":"query","description":"Organization","required":true,"schema":{"type":"string","example":""}},{"name":"scope","in":"query","description":"Scope","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["user","organization","group"]}}},{"name":"user","in":"query","description":"User","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developer.calendly.com/api-docs/calendly-api/webhooks/get-sample-webhook-data","api_endpoint":"https://api.calendly.com/sample_webhook_data"},"summary":"Get sample webhook data","description":"Test your webhook subscription <Info title=\"Required scopes\"> > `webhooks:read` </Info>","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}