Internal meeting notes
status: active start_time: '2019-08-24T14:15:22.123456Z' end_time: '2019-08-24T14:15:22.123456Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: Calendly Office additional_info: Please check in at the main lobby. invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.092125Z' updated_at: '2019-01-02T03:04:05.092125Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith buffered_end_time: '2019-08-24T14:15:22.123456Z' buffered_start_time: '2019-08-24T14:15:22.123456Z' event_guests: - email: user@example.com created_at: '2022-04-21T17:10:48.484945Z' updated_at: '2022-04-21T17:11:01.758636Z' calendar_event: kind: google external_id: 8suu9k3hj00mni03ss12ba0ce0 pagination: count: 20 next_page: 'https://api.calendly.com/scheduled_events?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi' previous_page: 'https://api.calendly.com/scheduled_events?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H' next_page_token: sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi previous_page_token: VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/GET_SCHEDULED_EVENTS_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: list-scheduled-events parameters: [] /event_types: get: 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. > #### Required scopes: `event_types:read` tags: - Event Types security: - oauth2: [] - personal_access_token: [] parameters: - name: active description: 'Return only active event types if true, only inactive if false, or all event types if this parameter is omitted.' in: query schema: type: boolean - name: organization description: 'View available personal, team, and organization event types associated with the organization''s URI.' in: query schema: type: string format: uri required: false - name: user description: 'View available personal, team, and organization event types associated with the user''s URI.' in: query schema: type: string format: uri required: false - name: user_availability_schedule description: 'Used in conjunction with `user` parameter, returns a filtered list of Event Types that use the given primary availability schedule.' in: query schema: type: string format: uri required: false - name: sort in: query schema: type: string default: 'name:asc' 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.' examples: withOmittedDirection: summary: Omit direction with fallback to asc by default value: name - name: admin_managed 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.' in: query schema: type: boolean required: false - $ref: '#/components/parameters/PageToken' - $ref: '#/components/parameters/Count' responses: '200': description: OK content: application/json: schema: type: object description: Service response properties: collection: type: array items: $ref: '#/components/schemas/EventType' pagination: $ref: '#/components/schemas/Pagination' required: - collection - pagination examples: Example: value: collection: - uri: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' name: 15 Minute Meeting active: true booking_method: instant slug: acmesales scheduling_url: 'https://calendly.com/acmesales' duration: 15 duration_options: - 1 - 13 - 15 - 720 kind: solo pooling_type: round_robin type: StandardEventType color: '#fff200' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' internal_note: Internal note is_paid: false description_plain: 15 Minute Meeting description_html:15 Minute Meeting
profile: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' secret: true deleted_at: null admin_managed: false locations: - kind: inbound_call phone_number: + 380934567654 additional_info: Additional information about location position: 0 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 answer_choices: - '1' - 2-10 - 11-20 - 20+ enabled: true include_other: true position: 2 required: false type: single_select - name: Multi-Select Question answer_choices: - Answer 1 - Answer 2 - Answer 3 - Answer 4 enabled: true include_other: true position: 2 required: false type: multi_select - name: Phone Number type: phone_number position: 0 enabled: true required: true answer_choices: [] include_other: false locale: en 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 '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/EVENT_TYPES_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: list-event-types post: summary: Create Event Type description: |- Create a new Event Type **NOTE:** * Currently, this endpoint only supports one-on-one event types (kind: "solo"). > #### Required scopes: `event_types:write` x-internal: false tags: - Event Types security: - oauth2: [] - personal_access_token: [] responses: '201': description: Created content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/EventType' required: - resource '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: create-event-type x-stoplight: id: nuowpx7qfagsc requestBody: required: true content: application/json: schema: type: object required: - owner - name properties: active: type: boolean description: Indicates if the event type is active or not default: false owner: type: string description: The owner for this event type format: uri example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' name: type: string description: The event type name example: 15 Minute Meeting description: type: string description: The event type description example: 15 Minute Meeting duration: type: integer description: The length of sessions booked with this event type. Must be one of the duration options if they're provided. example: 15 minimum: 1 maximum: 720 duration_options: type: array example: - 1 - 13 - 15 - 720 description: A maximum of 4 unique options is allowed. Each option must be >= 1 and <= 720. items: type: integer locations: type: array description: Configuration information for each possible location for this event type items: $ref: '#/components/schemas/LocationConfiguration' color: type: string x-stoplight: id: lu1stb7rwvql4 description: The hexadecimal color value of the event type's scheduling page pattern: '^#[a-f\d]{6}$' example: '#fff200' locale: type: string x-stoplight: id: mzonzpruv2cad enum: - de - en - es - fr - it - nl - pt - uk example: de description: 'The locale on the event type, used to determine the language of the event type''s scheduling page' parameters: [] '/users/{uuid}': get: summary: Get user tags: - Users security: - oauth2: [] - personal_access_token: [] parameters: - name: uuid in: path description: 'User unique identifier, or the constant "me" to reference the caller' required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: object description: Service response properties: resource: $ref: '#/components/schemas/User' required: - resource examples: Example: value: resource: uri: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' name: John Doe slug: acmesales email: test@example.com scheduling_url: 'https://calendly.com/acmesales' timezone: America/New York time_notation: 12h avatar_url: 'https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' current_organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' resource_type: User locale: en '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' description: |- Returns information about a specified User. > #### Required scopes: `users:read` operationId: get-user /users/me: get: summary: Get current user tags: - Users security: - oauth2: [] - personal_access_token: [] responses: '200': description: OK content: application/json: schema: type: object description: Service response properties: resource: $ref: '#/components/schemas/User' required: - resource examples: Example: value: resource: uri: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' name: John Doe slug: acmesales email: user@example.com scheduling_url: 'https://calendly.com/acmesales' timezone: America/New York time_notation: 12h avatar_url: 'https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' current_organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' resource_type: User locale: en '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' description: |- Returns basic information about your user account. > #### Required scopes: `users:read` operationId: get-current-user '/scheduled_events/{event_uuid}/invitees/{invitee_uuid}': parameters: - schema: type: string name: event_uuid in: path required: true description: The event's unique identifier - schema: type: string name: invitee_uuid in: path required: true description: The invitee's unique identifier get: summary: Get Event Invitee tags: - Scheduled Events responses: '200': description: OK content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/Invitee' required: - resource examples: Invitee: value: resource: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2022-04-21T17:11:43.092010Z' email: email@example.com rescheduled: false reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' event: 'https://api.calendly.com/scheduled_events/ABCDABCDABCDABCD' name: John Doe first_name: null last_name: null new_invitee: null old_invitee: null status: active text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-01-01T20:30:00.000000Z' uri: 'https://api.calendly.com/api/v2/scheduled_events/ABCDABCDABCDABCD/invitees/ABCDABCDABCDABCD' questions_and_answers: - answer: radio button answer position: 0 question: Question with Radio Buttons answer type - answer: |- Multiple line Answer position: 1 question: Question with Multiple Lines answer type - answer: |- Answer 1 Answer 2 Answer 3 position: 2 question: Question with Checkboxes answer type routing_form_submission: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' payment: external_id: ch_AAAAAAAAAAAAAAAAAAAAAAAA provider: stripe amount: 1234.56 currency: USD terms: 'sample terms of payment (up to 1,024 characters)' successful: true no_show: null reconfirmation: created_at: '2020-11-23T17:51:18.341657Z' confirmed_at: '2020-11-23T20:01:18.341657Z' scheduling_method: null invitee_scheduled_by: null Canceled Invitee: value: resource: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: John Doe first_name: null last_name: null new_invitee: null old_invitee: null questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: canceled text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:54:22.356897Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' cancellation: canceled_by: John Doe reason: Meeting Conflict canceler_type: invitee created_at: '2020-11-23T17:54:22.356897Z' routing_form_submission: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' payment: external_id: ch_AAAAAAAAAAAAAAAAAAAAAAAA provider: stripe amount: 1234.56 currency: USD terms: 'sample terms of payment (up to 1,024 characters)' successful: true no_show: null reconfirmation: null scheduling_method: null invitee_scheduled_by: null '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/GET_INVITEE_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: get-scheduled-event-invitees security: - oauth2: [] - personal_access_token: [] description: |- Returns information about a specified Invitee (person invited to an event). > #### Required scopes: `scheduled_events:read` /invitees: post: summary: Create Event Invitee (Scheduling API) tags: - Scheduled Events responses: '201': description: Created content: application/json: schema: type: object required: - resource properties: resource: $ref: '#/components/schemas/Invitee' '400': description: Request is not valid content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: title: type: string enum: - Invalid Argument - Deprecated message: type: string enum: - The supplied parameters are invalid. - Specified location kind is not configured for this event type. - Required Questions and Answers cannot be blank. - Event types that require payment cannot be scheduled via the API. '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/POST_INVITEES_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: post-invitee x-stoplight: id: p3ghrxrwbl8kqe 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. > #### Required scopes: `scheduled_events:write` x-internal: false requestBody: required: true content: application/json: schema: type: object required: - event_type - start_time - invitee properties: event_type: type: string x-stoplight: id: a7jkew1bxxq4j format: uri description: 'Canonical reference (unique identifier) for the event type being scheduled ' example: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' start_time: type: string x-stoplight: id: esu3e9ko2ic4f format: date-time description: The start time in UTC of the scheduled event example: '2019-08-07T06:05:04.321123Z' invitee: x-stoplight: id: 33r4biixcw7aa type: object required: - email - timezone properties: name: type: string x-stoplight: id: 0fmuo5ttqa3ys description: The full name of the invitee. **Required if** `first_name` **is not provided** example: John Smith first_name: type: string x-stoplight: id: mtx5mufknvhuj description: The first name of the invitee. **Required if** `name` **is not provided** example: John last_name: type: string x-stoplight: id: r96jzm1mdj3fv description: The last name of the invitee example: Smith email: type: string x-stoplight: id: 2nkp8zp5zotz0 description: The email of the invitee example: test@example.com timezone: type: string x-stoplight: id: gsxlntypi4xwm description: The timezone of the invitee example: America/New_York text_reminder_number: type: string x-stoplight: id: up34qo0c1sxon description: Invitee's phone number for SMS reminders. Must be a valid phone number (e.g. +14155551234) example: +1 888-888-8888 location: $ref: '#/components/schemas/InviteeLocation' questions_and_answers: type: array items: $ref: '#/components/schemas/InviteeQuestionAndAnswer' tracking: $ref: '#/components/schemas/InviteeTracking' event_guests: type: array x-stoplight: id: ws09zf1b2zd2i description: Emails of invitee guests. Max 10. maxItems: 10 items: x-stoplight: id: fy506ehfvcubw type: string format: email example: janedoe@calendly.com security: - oauth2: [] - personal_access_token: [] '/scheduled_events/{uuid}': parameters: - schema: type: string name: uuid in: path required: true description: The event's unique identifier get: summary: Get Event tags: - Scheduled Events responses: '200': description: OK content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/Event' required: - resource examples: Example: value: resource: uri: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: 15 Minute Meeting meeting_notes_plain: Internal meeting notes meeting_notes_html:Internal meeting notes
status: active booking_method: instant start_time: '2019-08-24T14:15:22.000000Z' end_time: '2019-08-24T14:15:22.000000Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: Calendly Office additional_info: Please check in at the main lobby. invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-01-02T03:04:05.678123Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith buffered_end_time: '2019-08-24T14:15:22.000000Z' buffered_start_time: '2019-08-24T14:15:22.000000Z' event_guests: - email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' calendar_event: kind: google external_id: 8suu9k3hj00mni03ss12ba0ce0 '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/GET_INVITEES_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: get-scheduled-event security: - oauth2: [] - personal_access_token: [] description: |- Returns information about a specified Event. > #### Required scopes: `scheduled_events:read` '/event_types/{uuid}': parameters: - schema: type: string name: uuid in: path required: true get: summary: Get Event Type tags: - Event Types responses: '200': description: OK content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/EventType' required: - resource examples: Example: value: resource: uri: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' name: 15 Minute Meeting active: true booking_method: instant slug: acmesales scheduling_url: 'https://calendly.com/acmesales' duration: 15 duration_options: - 1 - 13 - 15 - 720 kind: solo pooling_type: round_robin type: StandardEventType color: '#fff200' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' internal_note: Internal note is_paid: false description_plain: 15 Minute Meeting description_html:15 Minute Meeting
profile: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' secret: true deleted_at: null admin_managed: false locations: - kind: inbound_call phone_number: + 380934567654 additional_info: Additional information about location position: 0 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 answer_choices: - '1' - 2-10 - 11-20 - 20+ enabled: true include_other: true position: 2 required: false type: single_select - name: Multi-Select Question answer_choices: - Answer 1 - Answer 2 - Answer 3 - Answer 4 enabled: true include_other: true position: 2 required: false type: multi_select - name: Phone Number type: phone_number position: 0 enabled: true required: true answer_choices: [] include_other: false locale: en '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: get-event-type security: - oauth2: [] - personal_access_token: [] description: |- Returns information about a specified Event Type. > #### Required scopes: `event_types:read` patch: summary: Update Event Type description: |- Update an existing Event Type **NOTE:** * Currently, this endpoint only supports one-on-one event types (kind: "solo"). > #### Required scopes: `event_types:write` x-internal: false tags: - Event Types security: - oauth2: [] - personal_access_token: [] responses: '200': description: OK content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/EventType' required: - resource '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: update-event-type requestBody: required: true content: application/json: schema: type: object properties: active: type: boolean description: Indicates if the event type is active or not name: type: string description: The event type name example: 15 Minute Meeting color: description: The hexadecimal color value of the event type's scheduling page type: string pattern: '^#[a-f\d]{6}$' example: '#fff200' description: type: string description: The event type description example: 15 Minute Meeting duration: type: integer description: The length of sessions booked with this event type. Must be one of the duration options if they're provided. example: 15 minimum: 1 maximum: 720 duration_options: type: array items: type: integer example: - 1 - 13 - 15 - 720 description: A maximum of 4 unique options is allowed. Each option must be >= 1 and <= 720. locale: type: string enum: - de - en - es - fr - it - nl - pt - uk example: de description: 'The locale on the event type, used to determine the language of the event type''s scheduling page' locations: type: array description: Configuration information for each possible location for this Event Type items: $ref: '#/components/schemas/LocationConfiguration' '/organizations/{uuid}/invitations': parameters: - schema: type: string name: uuid in: path required: true description: The organization's unique identifier get: summary: List Organization Invitations responses: '200': description: OK content: application/json: schema: type: object properties: collection: type: array items: $ref: '#/components/schemas/OrganizationInvitation' pagination: $ref: '#/components/schemas/Pagination' required: - collection - pagination examples: Example: value: collection: - uri: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB' organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' email: test@example.com status: accepted created_at: '2019-08-07T06:05:04.321123Z' updated_at: '2019-01-02T03:04:05.678123Z' last_sent_at: '2019-01-02T03:04:05.678123Z' user: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' pagination: count: 20 next_page: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi' previous_page: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H' next_page_token: sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi previous_page_token: VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: list-organization-invitations description: |- Returns a list of Organization Invitations that were sent to the organization's members. > #### Required scopes: `organizations:read` security: - oauth2: [] - personal_access_token: [] parameters: - $ref: '#/components/parameters/Count' - $ref: '#/components/parameters/PageToken' - schema: type: string default: 'created_at:asc' in: query name: sort description: Order results by the field name and direction specified (ascending or descending). Returns multiple sets of results in a comma-separated list. - schema: type: string format: email example: bob@example.com in: query name: email description: Indicates if the results should be filtered by email address - schema: type: string enum: - pending - accepted - declined in: query name: status description: 'Indicates if the results should be filtered by status ("pending", "accepted", or "declined")' tags: - Organizations post: summary: Invite User to Organization responses: '201': description: Created content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/OrganizationInvitation' required: - resource examples: Invitation: value: resource: created_at: '2020-01-01T20:30:00.000000Z' email: email@example.com last_sent_at: '2020-01-01T20:30:00.123456Z' organization: 'https://api.calendly.com/organizations/ABCDABCDABCDABCD' status: pending updated_at: '2020-01-01T20:30:00.000000Z' uri: 'https://api.calendly.com/organizations/ABCDABCDABCDABCD/invitations/DCBADCBADCBADCBA' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Email is Invalid: value: title: Invalid Email message: invalid_email@example is an invalid email format Email is Blank: value: title: Invalid Argument message: The supplied parameters are invalid. details: - parameter: email message: must be filled Email Exists in Organization: value: title: Already Organization Member message: email@example.com is already in the organization Invitation Already Exists: value: title: Already Invited message: email@example.com has already been invited Race Condition: value: title: Race Condition message: A race condition occurred when processing the request. Please try the request again. '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/ORGANIZATION_INVITATION_CREATE_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: create-organization-invitation description: |- Invites a user to an organization. > #### Required scopes: `organizations:write` security: - oauth2: [] - personal_access_token: [] requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: The email of the user being invited format: email example: alice@example.com required: - email examples: Example: value: email: alice@example.com tags: - Organizations '/organizations/{org_uuid}/invitations/{uuid}': parameters: - schema: type: string name: org_uuid in: path required: true description: The organization’s unique identifier - schema: type: string name: uuid in: path description: The organization invitation's unique identifier required: true delete: summary: Revoke User's Organization Invitation tags: - Organizations responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Invitation Already Accepted: value: title: Invitation Already Accepted message: The invitation has already been accepted. '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/ORGANIZATION_INVITATION_DELETE_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: revoke-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. > #### Required scopes: `organizations:write` security: - oauth2: [] - personal_access_token: [] get: summary: Get Organization Invitation operationId: get-organization-invitation responses: '200': description: OK content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/OrganizationInvitation' required: - resource examples: Example: value: resource: uri: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB' organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' email: test@example.com status: accepted created_at: '2019-08-07T06:05:04.321123Z' updated_at: '2019-01-02T03:04:05.678123Z' last_sent_at: '2019-01-02T03:04:05.678123Z' user: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' description: |- Returns an Organization Invitation that was sent to the organization's members. > #### Required scopes: `organizations:read` security: - oauth2: [] - personal_access_token: [] tags: - Organizations '/organization_memberships/{uuid}': get: summary: Get Organization Membership tags: - Organizations security: - oauth2: [] - personal_access_token: [] responses: '200': description: OK content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/OrganizationMembership' required: - resource examples: Example: value: resource: uri: 'https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA' role: admin user: uri: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' name: John Doe slug: acmesales email: test@example.com scheduling_url: 'https://calendly.com/acmesales' timezone: America/New York time_notation: 12h avatar_url: 'https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png' locale: en created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' updated_at: '2019-08-07T06:05:04.321123Z' created_at: '2019-01-02T03:04:05.678123Z' '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/USER_NOT_IN_ORG_GENERIC_and_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' description: |- Returns information about a user's Organization Membership > #### Required scopes: `organizations:read` operationId: get-organization-membership delete: summary: Remove User from Organization tags: - Organizations operationId: delete-organization-membership responses: '204': description: No Content '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/ORG_MEMBERSHIP_DELETE_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' 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 > #### Required scopes: `organizations:write` security: - oauth2: [] - personal_access_token: [] parameters: - schema: type: string name: uuid in: path required: true description: The organization membership's unique identifier /organization_memberships: get: summary: List Organization Memberships tags: - Organizations security: - oauth2: [] - personal_access_token: [] parameters: - $ref: '#/components/parameters/PageToken' - $ref: '#/components/parameters/Count' - schema: type: string format: email example: user@example.com in: query name: email description: Indicates if the results should be filtered by email address - schema: type: string format: uri example: 'https://api.calendly.com/organizations/012345678901234567890' in: query name: organization description: Indicates if the results should be filtered by organization - schema: type: string example: 'https://api.calendly.com/users/012345678901234567890' format: uri in: query name: user description: Indicates if the results should be filtered by user - schema: type: string enum: - owner - admin - user example: owner in: query name: role description: Indicates if the results should be filtered by role responses: '200': description: OK content: application/json: schema: type: object description: Service response properties: collection: type: array items: $ref: '#/components/schemas/OrganizationMembership' pagination: $ref: '#/components/schemas/Pagination' required: - collection - pagination examples: Example: value: collection: - uri: 'https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA' role: admin user: uri: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' name: John Doe slug: acmesales email: test@example.com scheduling_url: 'https://calendly.com/acmesales' timezone: America/New York time_notation: 12h avatar_url: 'https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png' locale: en created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' updated_at: '2019-08-07T06:05:04.321123Z' created_at: '2019-01-02T03:04:05.678123Z' pagination: count: 20 next_page: 'https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi' previous_page: 'https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H' next_page_token: sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi previous_page_token: VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/USER_NOT_IN_ORG_GENERIC_and_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' 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. > #### Required scopes: `organizations:read` operationId: list-organization-memberships parameters: [] /webhook_subscriptions: post: summary: Create Webhook Subscription operationId: createwebhooks responses: '201': headers: Location: schema: type: string format: uri example: 'https://api.calendly.com/webhook_subscriptions/AAAAAAAAAAAAAAAA' description: Canonical reference (unique identifier) for the webhook description: Created content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/WebhookSubscription' required: - resource examples: Example: value: resource: uri: 'https://api.calendly.com/webhook_subscriptions/AAAAAAAAAAAAAAAA' callback_url: 'https://blah.foo/bar' created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' retry_started_at: '2019-08-24T14:15:22.123456Z' state: active events: - invitee.created scope: user organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' user: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' group: 'https://api.calendly.com/groups/AAAAAAAAAAAAAAAA' creator: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/POST_WEBHOOK_SUBS_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '409': description: Attempt to create a resource that already exists content: application/json: examples: URL Already Exists: value: title: Already Exists message: Hook with this url already exists schema: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: title: type: string enum: - Already Exists message: type: string enum: - Hook with this url already exists 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`15 Minute Meeting
profile: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' secret: true booking_method: poll custom_questions: - name: string type: string position: 0 enabled: true required: true answer_choices: - string include_other: true deleted_at: '2019-01-02T03:04:05.678123Z' admin_managed: true locations: - kind: inbound_call phone_number: + 380934567654 additional_info: Additional information about location position: 0 locale: en member: uri: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' name: John Doe slug: acmesales email: test@example.com scheduling_url: 'https://calendly.com/acmesales' timezone: America/New York time_notation: 12h avatar_url: 'https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' current_organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' resource_type: User locale: en updated_at: '2019-01-02T03:04:05.678123Z' created_at: '2019-01-02T03:04:05.678123Z' 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 '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: list-event-type-memberships parameters: - schema: type: string format: uri example: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' in: query name: event_type description: The uri associated with the event type required: true - $ref: '#/components/parameters/Count' - $ref: '#/components/parameters/PageToken' security: - personal_access_token: [] - oauth2: [] /one_off_event_types: post: summary: Create One-Off Event Type operationId: create-one-off-event-type responses: '201': description: Created content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/EventType' required: - resource examples: Example: value: resource: uri: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' name: 15 Minute Meeting active: true booking_method: instant slug: acmesales scheduling_url: 'https://calendly.com/acmesales' duration: 15 duration_options: null kind: solo pooling_type: collective type: AdhocEventType color: '#fff200' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' internal_note: Event type note is_paid: false description_plain: Event type description description_html:Event type description
profile: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/ABC123' secret: true deleted_at: null admin_managed: false locations: - kind: inbound_call phone_number: + 380934567654 additional_info: Additional information about location position: 0 custom_questions: [] locale: en '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/ONE_OFF_EVENTS_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' x-stoplight: id: v1yuxil3cpmxq x-internal: false description: |- Creates One-Off Event Type > #### Required scopes: `event_types:write` parameters: [] security: - oauth2: [] - personal_access_token: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string x-stoplight: id: 0tj6bpbhb3zax description: Event type name example: My Meeting maxLength: 55 host: type: string x-stoplight: id: g80s05pbxm7bq description: Host user uri example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' format: uri co_hosts: type: array x-stoplight: id: smhocxmji8deh maxItems: 9 description: Collection of meeting co-host(s) user URIs items: x-stoplight: id: 0nqgfaej6nlv1 type: string format: uri duration: type: number x-stoplight: id: r2qqy76sh5ikv maximum: 720 description: Duration of meeting in minutes timezone: type: string x-stoplight: id: hsu3tz8o7ykos description: Time zone used for meeting. Defaults to host's time zone. example: America/New_York date_setting: x-stoplight: id: hskuoq7f14ynp oneOf: - $ref: '#/components/schemas/DateRange' - $ref: '#/components/schemas/DaysInFuture' - type: object x-sl-internally-excluded: true x-sl-error-message: You do not have permission to view this reference location: oneOf: - $ref: '#/components/schemas/AdhocCustomLocation' - $ref: '#/components/schemas/AdhocGoogleConference' - $ref: '#/components/schemas/AdhocGotoMeetingConference' - $ref: '#/components/schemas/AdhocInPersonMeeting' - $ref: '#/components/schemas/AdhocInboundCall' - $ref: '#/components/schemas/AdhocInviteeSpecifiedLocation' - $ref: '#/components/schemas/AdhocMicrosoftTeamsConference' - $ref: '#/components/schemas/AdhocOutboundCall' - $ref: '#/components/schemas/AdhocWebExConference' - $ref: '#/components/schemas/AdhocZoomConference' required: - name - host - duration - date_setting examples: 'Example: date_range': value: name: My Meeting host: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' co_hosts: - 'https://api.calendly.com/users/BBBBBBBBBBBBBBBB' - 'https://api.calendly.com/users/CCCCCCCCCCCCCCCC' duration: 30 timezone: string date_setting: type: date_range start_date: '2020-01-07' end_date: '2020-01-09' location: kind: physical location: Main Office additonal_info: string 'Example: days_in_future': value: name: My Meeting host: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' co_hosts: - 'https://api.calendly.com/users/BBBBBBBBBBBBBBBB' - 'https://api.calendly.com/users/CCCCCCCCCCCCCCCC' duration: 30 timezone: string date_setting: type: days_in_future days: 60 only_weekdays: false location: kind: physical location: Main Office additonal_info: string 'Example: spots': value: name: My Meeting host: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' co_hosts: - 'http://example.com' duration: 720 timezone: America/New_York date_setting: type: spots spots: - start_time: '2020-01-02T11:30:00.000000Z' end_time: '2020-01-02T12:00:00.000000Z' location: kind: custom location: string description: Parameters for creating One-Off Event Type tags: - Event Types parameters: [] /sample_webhook_data: get: x-internal: false summary: Get sample webhook data tags: - Webhooks responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebhookPayload' '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: get-sample-webhook-data description: |- Test your webhook subscription > #### Required scopes: `webhooks:read` security: - oauth2: [] - personal_access_token: [] parameters: - schema: 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 in: query name: event required: true - schema: type: string format: uri example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' in: query name: organization required: true - schema: type: string format: uri example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' in: query name: user - schema: type: string enum: - user - organization - group in: query name: scope required: true - schema: type: string example: 'https://api.calendly.com/groups/AAAAAAAAAAAAAAAA' format: uri in: query name: group /outgoing_communications: get: summary: List outgoing communications x-internal: false tags: - Outgoing Communications operationId: get-outgoing-communications description: |- > This endpoint requires an Enterprise subscription. > > #### Required scopes: `outgoing_communications:read` Returns a list of outgoing SMS and email communications. parameters: - name: organization in: query schema: type: string format: uri example: 'https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ' required: true description: Return outgoing communications from the organization associated with this URI - name: count in: query schema: type: integer default: 20 minimum: 1 maximum: 100 description: The number of records to return - name: min_created_at in: query schema: type: string format: date-time 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' example: '2020-01-02T12:30:00Z' - name: max_created_at in: query schema: type: string format: date-time 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' example: '2020-01-02T12:30:00Z' - name: page_token in: query schema: type: string description: The token to pass to get the next portion of the collection responses: '200': description: OK content: application/json: schema: type: object description: Outgoing communications response additionalProperties: false properties: collection: type: array description: The communications matching the criteria items: anyOf: - $ref: '#/components/schemas/sms' - $ref: '#/components/schemas/email' pagination: $ref: '#/components/schemas/Pagination' total_count: type: integer description: Total number of records based on search criteria minimum: 0 required: - collection - pagination - total_count '400': $ref: '#/components/responses/INVALID_ARGUMENT' '403': $ref: '#/components/responses/ENTERPRISE_OWNER_ADMIN_FEATURE_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' security: - oauth2: [] - personal_access_token: [] /groups: get: summary: List Groups tags: - Groups responses: '200': description: OK content: application/json: schema: type: object required: - collection - pagination properties: collection: type: array x-stoplight: id: q0ayom0hx12xp items: $ref: '#/components/schemas/Group' pagination: $ref: '#/components/schemas/Pagination' '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' operationId: get-groups x-stoplight: id: 6rb6dtdln74sy description: |- Returns a list of groups. > #### Required scopes: `groups:read` security: - oauth2: [] personal_access_token: [] parameters: - schema: type: string in: query name: organization description: Return groups that are associated with the organization associated with this URI required: true - $ref: '#/components/parameters/PageToken' - $ref: '#/components/parameters/Count' /locations: get: summary: List User Meeting Locations tags: - Locations security: - oauth2: [] - personal_access_token: [] parameters: - name: user in: query schema: type: string format: uri example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' description: The URI associated with the user required: true responses: '200': description: OK content: application/json: schema: type: object description: Service response properties: collection: type: array description: The collection of user meeting locations items: $ref: '#/components/schemas/MeetingLocation' required: - collection examples: Example: value: collection: - kind: zoom_conference connected: true - kind: google_conference connected: true - kind: gotomeeting_conference connected: false - kind: microsoft_teams_conference connected: true - kind: webex_conference connected: false - kind: inbound_call - kind: ask_invitee - kind: custom - kind: inbound_call - kind: physical '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/LOCATIONS_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' description: |- Returns configured location information for a given user. > #### Required scopes: `locations:read` operationId: list-user-locations x-internal: false /event_type_availability_schedules: get: summary: List Event Type Availability Schedules tags: - Availability security: - oauth2: [] - personal_access_token: [] parameters: - name: event_type in: query schema: type: string format: uri example: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' description: The URI associated with the event type required: true responses: '200': description: OK content: application/json: schema: type: object properties: collection: type: array x-stoplight: id: ieo7sr95bw8un items: $ref: '#/components/schemas/EventTypeAvailabilitySchedule' pagination: $ref: '#/components/schemas/Pagination' required: - collection - pagination examples: Example: value: collection: - event_type: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' availability_setting: host availability_rule: timezone: America/New_York name: Working Hours uri: 'https://api.calendly.com/user_availability_schedules/ea00f052-41ee-44ee-a6fa-cbac655b8d74' user: 'https://api.calendly.com/users/abc123' rules: - type: wday intervals: - from: '08:30' to: '09:30' wday: sunday date: '2022-12-31' pagination: count: 20 next_page: 'https://api.calendly.com/event_type_availability_schedules?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi' previous_page: 'https://api.calendly.com/event_type_availability_schedules?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H' next_page_token: sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi previous_page_token: VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' description: |- Return the availability for an event type > #### Required scopes: `availability:read` operationId: get-event-type-availability x-internal: false x-stoplight: id: fc0784i5uemm2 patch: summary: Update Event Type Availability Schedules tags: - Availability responses: '200': description: OK content: application/json: schema: type: object required: - resource properties: resource: $ref: '#/components/schemas/EventTypeAvailabilitySchedule' examples: Example 1: value: resource: event_type: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' availability_rule: timezone: America/New_York name: Working Hours uri: 'https://api.calendly.com/user_availability_schedules/ea00f052-41ee-44ee-a6fa-cbac655b8d74' rules: - type: wday intervals: - from: '08:30' to: '09:30' wday: sunday - type: wday intervals: - from: '08:30' to: '09:30' - from: '11:30' to: '13:30' wday: tuesday - type: date intervals: - from: '00:00' to: '23:59' date: '2026-04-01' '400': $ref: '#/components/responses/INVALID_ARGUMENT' '401': $ref: '#/components/responses/UNAUTHENTICATED' '403': $ref: '#/components/responses/PERMISSION_DENIED_AND_SCOPES_FORBIDDEN' '404': $ref: '#/components/responses/NOT_FOUND' '500': $ref: '#/components/responses/UNKNOWN' security: - oauth2: [] - personal_access_token: [] parameters: - schema: type: string in: query name: event_type description: Event Type uri in which to update the availability schedule required: true requestBody: required: true content: application/json: schema: type: object required: - availability_rule properties: availability_rule: type: object x-stoplight: id: 1k57u40qbjcoe required: - timezone properties: timezone: type: string x-stoplight: id: t7ppm5kfbx3t3 description: The timezone for which this Event Type Availability Schedule is originated in. rules: type: array description: 'The rules for an availability schedule.Event type description
profile: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/ABC123' secret: true deleted_at: null admin_managed: false locations: - kind: inbound_call phone_number: 380934567654 additional_info: Additional information about location position: 0 custom_questions: - name: Company Name type: string position: 0 enabled: true required: true answer_choices: null include_other: false - name: What would you like to discuss? type: text position: 0 enabled: true required: true answer_choices: null include_other: false - name: Number of employees answer_choices: - '1' - 2-10 - 11-20 - 20+ enabled: true include_other: true position: 2 required: false type: single_select - name: Multi-Select Question answer_choices: - Answer 1 - Answer 2 - Answer 3 - Answer 4 enabled: true include_other: true position: 2 required: false type: multi_select - name: Phone Number type: phone_number position: 0 enabled: true required: true answer_choices: null include_other: false locale: en Adhoc Event Type: uri: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' name: 15 Minute Meeting active: true booking_method: instant slug: acmesales scheduling_url: 'https://calendly.com/acmesales' duration: 15 duration_options: null kind: solo pooling_type: null type: AdhocEventType color: '#fff200' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' internal_note: Event type note description_plain: Event type description description_html:Event type description
profile: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/ABC123' secret: true deleted_at: null admin_managed: false locations: - kind: inbound_call phone_number: 380934567654 additional_info: Additional information about location position: 0 custom_questions: [] locale: en required: - active - admin_managed - booking_method - color - created_at - custom_questions - deleted_at - description_html - description_plain - duration - duration_options - internal_note - is_paid - kind - locale - locations - name - pooling_type - position - profile - scheduling_url - secret - slug - type - updated_at - uri properties: active: description: Indicates if the event is active or not. type: boolean admin_managed: type: boolean description: Indicates if this event type is managed by an organization admin booking_method: type: string enum: - instant - poll example: poll description: Indicates if the event type is for a poll or an instant booking color: description: The hexadecimal color value of the event type's scheduling page type: string pattern: '^#[a-f\d]{6}$' example: '#fff200' created_at: description: 'The moment the event type was created (e.g. "2020-01-02T03:04:05.678123Z")' type: string format: date-time example: '2019-01-02T03:04:05.678123Z' custom_questions: type: array items: $ref: '#/components/schemas/EventTypeCustomQuestion' deleted_at: type: string description: 'The moment the event type was deleted (e.g. "2020-01-02T03:04:05.678123Z"). Since event types can be deleted but their scheduled events remain it''s useful to fetch a deleted event type when you still require event type data for a scheduled event.' format: date-time example: '2019-01-02T03:04:05.678123Z' nullable: true description_html: type: string description: The event type's description (formatted with HTML) example:15 Minute Meeting
nullable: true description_plain: type: string description: The event type's description (in non formatted text) example: 15 Minute Meeting nullable: true duration: description: The length of sessions booked with this event type type: number example: 15 duration_options: description: Array of duration options. Always null for adhoc event types. type: array example: - 1 - 13 - 15 - 720 nullable: true items: type: integer internal_note: type: string description: Contents of a note that may be associated with the event type example: Internal note nullable: true is_paid: type: boolean x-stoplight: id: 935ql9biw36u3 kind: description: Indicates if the event type is "solo" (belongs to an individual user) or "group" type: string enum: - solo - group locale: type: string enum: - en - fr - es - de - nl - pt - it - uk example: de description: 'The locale on the event type, used to determine the language of the event type''s scheduling page' locations: type: array description: Configuration information for each possible location for this Event Type nullable: true items: $ref: '#/components/schemas/LocationConfiguration' name: type: string description: The event type name (in human-readable format) example: 15 Minute Meeting nullable: true pooling_type: description: Indicates if the event type is "round robin" (alternates between hosts) or "collective" (invitees pick a time when all participants are available) or “multi-pool” (considers availability delineated by pools of participants) or "null" (the event type doesn’t consider the availability of a group participants) type: string enum: - round_robin - collective - multi_pool - null nullable: true position: type: integer description: 'Position order of Event Type, starting with 0 (for display purposes)' profile: $ref: '#/components/schemas/Profile' scheduling_url: type: string description: The URL of the user’s scheduling site where invitees book this event type format: uri example: 'https://calendly.com/acmesales' secret: type: boolean description: Indicates if the event type is hidden on the owner's main scheduling page slug: type: string description: The portion of the event type's URL that identifies a specific web page (in a human-readable format) example: acmesales nullable: true type: description: Indicates if the event type is "AdhocEventType" (ad hoc event) or "StandardEventType" (standard event type) type: string enum: - StandardEventType - AdhocEventType updated_at: description: 'The moment the event type was last updated (e.g. "2020-01-02T03:04:05.678123Z")' type: string format: date-time example: '2019-08-07T06:05:04.321123Z' uri: type: string description: Canonical reference (unique identifier) for the event type format: uri example: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' EventTypePayload: x-tags: - Event Types x-stoplight: id: 40p79rfl3wzkw type: object title: Event Type Webhook Payload description: A configuration for an Event Type x-examples: Standard Event Type: uri: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' name: 15 Minute Meeting active: true booking_method: instant slug: acmesales scheduling_url: 'https://calendly.com/acmesales' duration: 15 duration_options: - 1 - 13 - 15 - 720 kind: solo is_paid: false pooling_type: round_robin type: StandardEventType color: '#fff200' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' internal_note: Event type note description_plain: Event type description description_html:Event type description
profile: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/ABC123' secret: true deleted_at: null admin_managed: false locations: - kind: inbound_call phone_number: 380934567654 additional_info: Additional information about location position: 0 custom_questions: - name: Company Name type: string position: 0 enabled: true required: true answer_choices: null include_other: false - name: What would you like to discuss? type: text position: 0 enabled: true required: true answer_choices: null include_other: false - name: Number of employees answer_choices: - '1' - 2-10 - 11-20 - 20+ enabled: true include_other: true position: 2 required: false type: single_select - name: Multi-Select Question answer_choices: - Answer 1 - Answer 2 - Answer 3 - Answer 4 enabled: true include_other: true position: 2 required: false type: multi_select - name: Phone Number type: phone_number position: 0 enabled: true required: true answer_choices: null include_other: false locale: en Adhoc Event Type: uri: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' name: 15 Minute Meeting active: true booking_method: instant slug: acmesales scheduling_url: 'https://calendly.com/acmesales' duration: 15 duration_options: null kind: solo pooling_type: null type: AdhocEventType color: '#fff200' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' internal_note: Event type note description_plain: Event type description description_html:Event type description
profile: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/ABC123' secret: true deleted_at: null admin_managed: false locations: - kind: inbound_call phone_number: 380934567654 additional_info: Additional information about location position: 0 custom_questions: [] locale: en required: - uri - name - active - slug - scheduling_url - duration - duration_options - kind - pooling_type - type - color - created_at - updated_at - internal_note - is_paid - description_plain - profile - secret - booking_method - custom_questions - deleted_at - admin_managed - locations - position - locale properties: uri: type: string description: Canonical reference (unique identifier) for the event type format: uri example: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' name: type: string description: The event type name (in human-readable format) example: 15 Minute Meeting nullable: true active: description: Indicates if the event is active or not. type: boolean slug: type: string description: The portion of the event type's URL that identifies a specific web page (in a human-readable format) example: acmesales nullable: true scheduling_url: type: string description: The URL of the user’s scheduling site where invitees book this event type format: uri example: 'https://calendly.com/acmesales' duration: description: The length of sessions booked with this event type type: number example: 15 duration_options: description: Array of duration options. Always null for adhoc event types. type: array example: - 1 - 13 - 15 - 720 nullable: true items: type: integer kind: description: Indicates if the event type is "solo" (belongs to an individual user) or "group" type: string enum: - solo - group pooling_type: description: Indicates if the event type is "round robin" (alternates between hosts) or "collective" (invitees pick a time when all participants are available) or “multi-pool” (considers availability delineated by pools of participants) or "null" (the event type doesn’t consider the availability of a group participants) type: string enum: - round_robin - collective - multi_pool - null nullable: true type: description: Indicates if the event type is "AdhocEventType" (ad hoc event) or "StandardEventType" (standard event type) type: string enum: - StandardEventType - AdhocEventType color: description: The hexadecimal color value of the event type's scheduling page type: string pattern: '^#[a-f\d]{6}$' example: '#fff200' created_at: description: 'The moment the event type was created (e.g. "2020-01-02T03:04:05.678123Z")' type: string format: date-time example: '2019-01-02T03:04:05.678123Z' updated_at: description: 'The moment the event type was last updated (e.g. "2020-01-02T03:04:05.678123Z")' type: string format: date-time example: '2019-08-07T06:05:04.321123Z' internal_note: type: string description: Contents of a note that may be associated with the event type example: Internal note nullable: true is_paid: type: boolean x-stoplight: id: u6frivqne3enw description_plain: type: string description: The event type's description (in non formatted text) example: 15 Minute Meeting nullable: true profile: $ref: '#/components/schemas/Profile' secret: type: boolean description: Indicates if the event type is hidden on the owner's main scheduling page booking_method: type: string enum: - instant - poll example: poll description: Indicates if the event type is for a poll or an instant booking custom_questions: type: array items: $ref: '#/components/schemas/EventTypeCustomQuestion' deleted_at: type: string description: 'The moment the event type was deleted (e.g. "2020-01-02T03:04:05.678123Z"). Since event types can be deleted but their scheduled events remain it''s useful to fetch a deleted event type when you still require event type data for a scheduled event.' format: date-time example: '2019-01-02T03:04:05.678123Z' nullable: true admin_managed: type: boolean description: Indicates if this event type is managed by an organization admin locations: type: array description: Configuration information for each possible location for this Event Type nullable: true items: $ref: '#/components/schemas/LocationConfiguration' position: type: integer description: 'Position order of Event Type, starting with 0 (for display purposes)' locale: type: string enum: - en - fr - es - de - nl - pt - it - uk example: de description: 'The locale on the event type, used to determine the language of the event type''s scheduling page' EventTypeAvailabilitySchedule: x-tags: - Availability type: object description: A configuration for an Event Type Availability Schedule title: Event Type Availability Schedule x-examples: Example: event_type: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' availability_setting: host availability_rule: timezone: America/New_York name: Working Hours uri: 'https://api.calendly.com/user_availability_schedules/ea00f052-41ee-44ee-a6fa-cbac655b8d74' user: 'https://api.calendly.com/users/abc123' rules: - type: wday intervals: - from: '08:30' to: '09:30' wday: sunday - type: date intervals: - from: '08:30' to: '09:30' date: '2028-12-31' properties: event_type: type: string description: The URI of the event type associated with the Event Type Availability Schedule format: uri example: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' availability_setting: enum: - host description: The setting for event type availability specifies if all hosts follow the same schedule or if each host has their own unique schedule on the event type. default: host availability_rule: type: object x-stoplight: id: tufl39k0laf82 properties: timezone: type: string x-stoplight: id: 4v868xazlc3w1 description: The timezone for which this Event Type Availability Schedule is originated in. uri: type: string format: uri description: Canonical reference (unique identifier) for the Availability Schedule that is referenced in the Event Type. name: type: string nullable: true description: The name of the Availability Schedule that is referenced in the Event Type. user: type: string format: uri example: 'https://api.calendly.com/users/abc123' description: A URI reference to a user to be returned if availability_setting is not 'all' rules: type: array x-stoplight: id: 0jbqvez835dot items: $ref: '#/components/schemas/AvailabilityRule' x-internal: false Profile: x-tags: - Event Types type: object nullable: true description: 'The publicly visible profile of a User or a Team that''s associated with the Event Type (note: some Event Types don''t have profiles)' title: Profile properties: type: type: string description: Indicates if the profile belongs to a "user" (individual) or "team" enum: - User - Team example: User name: type: string description: Human-readable name for the profile of the user that's associated with the event type example: Tamara Jones owner: type: string description: The unique reference to the user associated with the profile format: uri example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' required: - type - name - owner x-examples: Example: type: User name: Tamara Jones owner: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' Event: x-tags: - Scheduled Events type: object description: Information about a scheduled meeting title: Event x-examples: Example: uri: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: 15 Minute Meeting meeting_notes_plain: Internal meeting notes meeting_notes_html:Internal meeting notes
status: active start_time: '2019-08-24T14:15:22.123456Z' end_time: '2019-08-24T14:15:22.123456Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: string additional_info: string invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-01-02T03:04:05.678123Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith event_guests: - email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' properties: uri: type: string format: uri description: Canonical reference (unique identifier) for the resource example: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: type: string description: The event name example: 15 Minute Meeting nullable: true meeting_notes_plain: type: string description: The internal meeting notes (in non formatted text) example: 15 Minute Meeting nullable: true meeting_notes_html: type: string description: The internal meeting notes (formatted with HTML) example:15 Minute Meeting
status: type: string enum: - active - canceled description: Indicates if the event is "active" or "canceled" start_time: type: string format: date-time description: 'The moment the event was scheduled to start in UTC time (e.g. "2020-01-02T03:04:05.678123Z").' end_time: type: string format: date-time description: 'The moment the event was scheduled to end in UTC time (e.g. "2020-01-02T03:04:05.678123Z")' event_type: type: string description: The event type associated with this event format: uri example: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: $ref: '#/components/schemas/Location' invitees_counter: type: object required: - total - active - limit properties: total: type: number description: 'Total invitees for an event, including invitees that have canceled' active: type: number description: Total invitees for an event that have not canceled limit: type: number description: Maximum number of active invitees that can book the event created_at: type: string format: date-time description: 'The moment when the event was created (e.g. "2020-01-02T03:04:05.678123Z")' example: '2019-01-02T03:04:05.678123Z' updated_at: type: string format: date-time description: 'The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")' example: '2019-01-02T03:04:05.678123Z' event_memberships: type: array description: Event membership list items: type: object properties: user: type: string format: uri description: Canonical reference (unique identifier) for the user example: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: type: string format: email description: The user's email example: user@example.com user_name: type: string description: The user's name example: John Smith buffered_end_time: type: string format: date-time description: The moment the membership's time buffer ends for the event in UTC time example: '2020-01-02T03:04:05.678123Z' buffered_start_time: type: string format: date-time description: The moment the membership's time buffer starts for the event in UTC time example: '2020-01-02T03:04:05.678123Z' required: - user event_guests: type: array description: Additional people added to an event by an invitee items: $ref: '#/components/schemas/Guest' cancellation: $ref: '#/components/schemas/Cancellation' calendar_event: $ref: '#/components/schemas/LegacyCalendarEvent' required: - uri - name - status - start_time - end_time - event_type - location - invitees_counter - created_at - updated_at - event_memberships - event_guests - calendar_event LegacyCalendarEvent: x-tags: - Scheduled Events type: object description: Information about the calendar event from the calendar provider. title: CalendarEvent x-examples: Example: kind: google external_id: 8suu9k3hj00mni03ss12ba0ce0 deprecated: true nullable: true properties: kind: type: string description: Indicates the calendar provider the event belongs to. example: google enum: - exchange - google - icloud - outlook - outlook_desktop deprecated: true external_id: type: string example: 8suu9k3hj00mni03ss12ba0ce0 description: the id provided from the calendar provider for this calendar event. deprecated: true required: - kind - external_id Cancellation: x-tags: - Scheduled Events type: object description: Provides data pertaining to the cancellation of the Event or the Invitee properties: canceled_by: type: string description: Name of the person whom canceled reason: type: string description: Reason that the cancellation occurred nullable: true canceler_type: type: string enum: - host - invitee created_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: The moment when the cancellation was created required: - canceled_by - reason - canceler_type - created_at Invitee: x-tags: - Scheduled Events type: object description: An individual who has been invited to meet with a Calendly member title: Invitee x-examples: Invitee: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' first_name: John last_name: Doe name: John Doe new_invitee: null old_invitee: null questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: active text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:51:18.341657Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' routing_form_submission: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' payment: external_id: ch_AAAAAAAAAAAAAAAAAAAAAAAA provider: stripe amount: 1234.56 currency: USD terms: 'sample terms of payment (up to 1,024 characters)' successful: true no_show: uri: 'https://api.calendly.com/invitee_no_shows/6ee96ed4-83a3-4966-a278-cd19b3c02e09' created_at: '2020-11-23T17:51:18.341657Z' reconfirmation: created_at: '2020-11-23T17:51:18.341657Z' confirmed_at: '2020-11-23T20:01:18.341657Z' scheduling_method: null invitee_scheduled_by: null Canceled Invitee: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' first_name: John last_name: Doe name: John Doe new_invitee: null old_invitee: null questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: canceled text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:54:22.356897Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' cancellation: canceled_by: John Doe reason: Meeting Conflict canceler_type: invitee created_at: '2020-11-23T17:54:22.356897Z' routing_form_submission: null payment: external_id: ch_AAAAAAAAAAAAAAAAAAAAAAAA provider: stripe amount: 1234.56 currency: USD terms: 'sample terms of payment (up to 1,024 characters)' successful: true reconfirmation: null scheduling_method: null invitee_scheduled_by: null properties: uri: type: string format: uri description: Canonical reference (unique identifier) for the invitee example: 'https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' email: type: string format: email description: The invitee’s email address example: test@example.com first_name: type: string description: The first name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name. Null when event type is configured to use a single field for name. example: John nullable: true last_name: type: string description: The last name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name. Null when event type is configured to use a single field for name. example: Doe nullable: true name: type: string description: The invitee’s name (in human-readable format) example: John Doe status: type: string enum: - active - canceled description: Indicates if the invitee is "active" or "canceled" questions_and_answers: type: array description: A collection of the invitee's responses to questions on the event booking confirmation form minItems: 0 uniqueItems: true items: $ref: '#/components/schemas/InviteeQuestionAndAnswer' timezone: type: string description: Time zone to use when displaying time to the invitee nullable: true event: type: string format: uri description: A reference to the event example: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' created_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: 'The moment when the event was created (e.g. "2020-01-02T03:04:05.678123Z")' updated_at: type: string format: date-time example: '2019-08-07T06:05:04.321123Z' description: 'The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")' tracking: $ref: '#/components/schemas/InviteeTracking' text_reminder_number: type: string example: +1 404-555-1234 description: The phone number to use when sending text (SMS) reminders nullable: true rescheduled: type: boolean description: 'Indicates if this invitee has rescheduled. If `true`, a reference to the new Invitee instance is provided in the `new_invitee` field.' old_invitee: type: string format: uri description: Reference to old Invitee instance that got rescheduled nullable: true new_invitee: type: string format: uri description: 'Link to new invitee, after reschedule' nullable: true cancel_url: type: string format: uri description: Link to cancelling the event for the invitee reschedule_url: type: string format: uri description: Link to rescheduling the event for the invitee routing_form_submission: type: string format: uri example: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' description: Reference to a routing form submission that redirected the invitee to a booking page. nullable: true cancellation: $ref: '#/components/schemas/Cancellation' payment: description: Invitee payment type: object required: - external_id - provider - amount - currency - terms - successful nullable: true properties: external_id: type: string description: Unique identifier for the payment provider: type: string description: Payment provider enum: - stripe - paypal example: stripe amount: type: number description: The amount of the payment format: float currency: type: string description: The currency format that the payment is in. enum: - AUD - CAD - EUR - GBP - USD terms: type: string description: Terms of the payment example: 'sample terms of payment (up to 1,024 characters)' nullable: true successful: type: boolean description: Indicates whether the payment was successfully processed no_show: description: Provides data pertaining to the associated no show for the Invitee type: object required: - uri - created_at nullable: true properties: uri: type: string description: Canonical reference (unique identifier) for the no show created_at: type: string example: '2019-01-02T03:04:05.678123Z' format: date-time description: The moment when the no show was created reconfirmation: type: object description: 'Assuming reconfirmation is enabled for the event type, when reconfirmation is requested this object is present with a `created_at` that reflects when the reconfirmation notification was sent. Once the invitee has reconfirmed the `confirmed_at` attribute will change from `null` to a timestamp that reflects when they took action.' required: - created_at - confirmed_at nullable: true properties: created_at: type: string description: When the reconfirmation was created. format: date-time example: '2020-11-23T17:51:18.341657Z' confirmed_at: type: string description: When the Invitee confirmed their attendance. format: date-time example: '2020-11-23T17:51:18.341657Z' nullable: true scheduling_method: type: string description: The method used to schedule the event enum: - instant_book - api - null nullable: true invitee_scheduled_by: type: string format: uri description: Reference to user URI who scheduled the event nullable: true required: - uri - email - first_name - last_name - name - status - questions_and_answers - timezone - event - created_at - updated_at - tracking - text_reminder_number - rescheduled - old_invitee - new_invitee - cancel_url - reschedule_url - routing_form_submission - payment - no_show - reconfirmation - scheduling_method - invitee_scheduled_by Guest: x-tags: - Scheduled Events title: Guest type: object description: An individual whom an invitee has invited to be a guest attendee to an event properties: email: type: string format: email created_at: type: string format: date-time updated_at: type: string format: date-time required: - email - created_at - updated_at x-examples: Example: email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' Organization: x-tags: - Organizations type: object title: Organization description: Organization object properties: uri: type: string format: uri description: Canonical resource reference example: 'https://api.calendly.com/organizations/012345678901234567890' kind: type: string description: Indicates whether the organization is a single-user or multiple-user organization enum: - single - multiple example: multiple name: type: string description: The Organization name (in human-readable format) example: Sales Team plan: type: string enum: - basic - essentials - standard - professional - teams - enterprise example: professional description: Active subscription plan or trial plan stage: type: string enum: - trial - free - paid example: paid description: Current stage of organization created_at: type: string format: date-time description: Timestamp of when the organization was created. example: '2019-01-02T03:04:05.678123Z' updated_at: type: string format: date-time description: Timestamp of when the organization was created or updated. example: '2019-08-07T06:05:04.321123Z' required: - uri - kind - plan - stage - created_at - updated_at OrganizationMembership: x-tags: - Organizations type: object title: Organization Membership properties: uri: type: string format: uri description: Canonical reference (unique identifier) for the membership example: 'https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA' role: type: string description: The user's role in the organization enum: - user - admin - owner example: admin user: type: object description: Information about the user. required: - uri - name - slug - email - scheduling_url - timezone - avatar_url - locale - created_at - updated_at properties: uri: type: string format: uri description: Canonical reference (unique identifier) for the user example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' name: type: string description: The user's name (human-readable format) example: John Doe slug: type: string description: 'The portion of URL for the user''s scheduling page (where invitees book sessions), rendered in a human-readable format' example: acmesales email: type: string format: email description: The user's email address example: test@example.com scheduling_url: type: string format: uri description: The URL of the user's Calendly landing page (that lists all the user's event types) example: 'https://calendly.com/acmesales' timezone: type: string example: America/New York description: The time zone to use when presenting time to the user avatar_url: type: string nullable: true format: uri description: The URL of the user's avatar (image) example: 'https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png' locale: type: string enum: - en - fr - es - de - pt - ps example: de description: The user's language preference created_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: 'The moment when the user''s record was created (e.g. "2020-01-02T03:04:05.678123Z")' updated_at: type: string format: date-time example: '2019-08-07T06:05:04.321123Z' description: 'The moment when the user''s record was last updated (e.g. "2020-01-02T03:04:05.678123Z")' organization: type: string format: uri description: A unique reference to the organization example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' updated_at: type: string format: date-time example: '2019-08-07T06:05:04.321123Z' description: 'The moment when the membership record was last updated (e.g. "2020-01-02T03:04:05.678123Z")' created_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: 'The moment when the membership record was created (e.g. "2020-01-02T03:04:05.678123Z")' required: - uri - role - user - organization - updated_at - created_at x-examples: Example: uri: 'https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA' role: admin user: uri: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' name: John Doe slug: acmesales email: test@example.com scheduling_url: 'https://calendly.com/acmesales' timezone: America/New York time_notation: 12h avatar_url: 'https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png' locale: en created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' updated_at: '2019-08-07T06:05:04.321123Z' created_at: '2019-01-02T03:04:05.678123Z' OrganizationInvitation: title: Organization Invitation type: object x-tags: - Organizations description: Organization Invitation object properties: uri: type: string description: Canonical reference (unique identifier) for the organization invitation format: uri example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB' organization: type: string description: Canonical reference (unique identifier) for the organization example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' email: type: string description: The email address of the person who was invited to join the organization format: email example: test@example.com status: type: string description: 'The status of the invitation ("pending", "accepted", or "declined")' enum: - pending - accepted - declined example: accepted created_at: type: string format: date-time example: '2019-08-07T06:05:04.321123Z' description: 'The moment the invitation was created (e.g. “2020-01-02T03:04:05.678123Z")' updated_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: 'The moment the invitation was last updated (e.g. "2020-01-02T03:04:05.678123Z")' last_sent_at: type: string nullable: true description: 'The moment the invitation was last sent (e.g. "2020-01-02T03:04:05.678123Z")' format: date-time example: '2019-01-02T03:04:05.678123Z' user: type: string format: uri description: 'When the invitation is accepted, a reference to the user who accepted the invitation' example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' required: - uri - organization - email - status - created_at - updated_at - last_sent_at x-examples: Example: uri: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB' organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' email: test@example.com status: accepted created_at: '2019-08-07T06:05:04.321123Z' updated_at: '2019-01-02T03:04:05.678123Z' last_sent_at: '2019-01-02T03:04:05.678123Z' user: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' InviteePayload: x-tags: - Webhooks type: object description: 'The payload that is sent via Webhook when an invitee creates or schedules a meeting, and when an invitee cancels.' title: Invitee Payload x-examples: Invitee: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' first_name: John last_name: Doe name: John Doe new_invitee: null old_invitee: null questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: active text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:51:18.341657Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' canceled: false routing_form_submission: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' payment: external_id: ch_AAAAAAAAAAAAAAAAAAAAAAAA provider: stripe amount: 1234.56 currency: USD terms: 'sample terms of payment (up to 1,024 characters)' successful: true no_show: uri: 'https://api.calendly.com/invitee_no_shows/6ee96ed4-83a3-4966-a278-cd19b3c02e09' created_at: '2020-11-23T17:51:18.341657Z' reconfirmation: created_at: '2020-11-23T17:51:18.341657Z' confirmed_at: '2020-11-23T20:01:18.341657Z' scheduling_method: null invitee_scheduled_by: null scheduled_event: uri: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: 15 Minute Meeting meeting_notes_plain: Internal meeting notes meeting_notes_html:Internal meeting notes
status: active start_time: '2019-08-24T14:15:22.123456Z' end_time: '2019-08-24T14:15:22.123456Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: string additional_info: string invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-01-02T03:04:05.678123Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith event_guests: - email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' Canceled Invitee: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' first_name: John last_name: Doe name: John Doe new_invitee: null old_invitee: null questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: canceled text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:54:22.356897Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' canceled: true cancellation: canceled_by: John Doe reason: Meeting Conflict canceler_type: invitee created_at: '2020-11-23T17:54:22.356897Z' routing_form_submission: null payment: external_id: ch_AAAAAAAAAAAAAAAAAAAAAAAA provider: stripe amount: 1234.56 currency: USD terms: 'sample terms of payment (up to 1,024 characters)' successful: true reconfirmation: null scheduling_method: null invitee_scheduled_by: null scheduled_event: uri: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: 15 Minute Meeting meeting_notes_plain: Internal meeting notes meeting_notes_html:Internal meeting notes
status: active start_time: '2019-08-24T14:15:22.123456Z' end_time: '2019-08-24T14:15:22.123456Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: string additional_info: string invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-01-02T03:04:05.678123Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith event_guests: - email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' properties: uri: type: string format: uri description: Canonical reference (unique identifier) for the invitee example: 'https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' email: type: string format: email description: The invitee’s email address example: test@example.com first_name: type: string description: The first name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name. Null when event type is configured to use a single field for name. example: John nullable: true last_name: type: string description: The last name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name. Null when event type is configured to use a single field for name. example: Doe nullable: true name: type: string description: The invitee’s name (in human-readable format) example: John Doe status: type: string enum: - active - canceled description: Indicates if the invitee is "active" or "canceled" questions_and_answers: type: array description: A collection of the invitee's responses to questions on the event booking confirmation form minItems: 0 uniqueItems: true items: $ref: '#/components/schemas/InviteeQuestionAndAnswer' timezone: type: string description: Time zone to use when displaying time to the invitee nullable: true event: type: string format: uri description: A reference to the event example: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' created_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: 'The moment when the event was created (e.g. "2020-01-02T03:04:05.678123Z")' updated_at: type: string format: date-time example: '2019-08-07T06:05:04.321123Z' description: 'The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")' tracking: $ref: '#/components/schemas/InviteeTracking' text_reminder_number: type: string example: +1 404-555-1234 description: The phone number to use when sending text (SMS) reminders nullable: true rescheduled: type: boolean description: 'Indicates if this invitee has rescheduled. If `true`, a reference to the new Invitee instance is provided in the `new_invitee` field.' old_invitee: type: string format: uri description: Reference to old Invitee instance that got rescheduled nullable: true new_invitee: type: string format: uri description: 'Link to new invitee, after reschedule' nullable: true cancel_url: type: string format: uri description: Link to cancelling the event for the invitee reschedule_url: type: string format: uri description: Link to rescheduling the event for the invitee routing_form_submission: type: string format: uri example: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' description: Reference to a routing form submission that redirected the invitee to a booking page. nullable: true cancellation: $ref: '#/components/schemas/Cancellation' payment: description: Invitee payment type: object required: - external_id - provider - amount - currency - terms - successful nullable: true properties: external_id: type: string description: Unique identifier for the payment provider: type: string description: Payment provider enum: - stripe - paypal example: stripe amount: type: number description: The amount of the payment format: float currency: type: string description: The currency format that the payment is in. enum: - AUD - CAD - EUR - GBP - USD terms: type: string description: Terms of the payment example: 'sample terms of payment (up to 1,024 characters)' nullable: true successful: type: boolean description: Indicates whether the payment was successfully processed no_show: description: Provides data pertaining to the associated no show for the Invitee type: object required: - uri - created_at nullable: true properties: uri: type: string description: Canonical reference (unique identifier) for the no show created_at: type: string example: '2019-01-02T03:04:05.678123Z' format: date-time description: The moment when the no show was created reconfirmation: type: object description: 'Assuming reconfirmation is enabled for the event type, when reconfirmation is requested this object is present with a `created_at` that reflects when the reconfirmation notification was sent. Once the invitee has reconfirmed the `confirmed_at` attribute will change from `null` to a timestamp that reflects when they took action.' required: - created_at - confirmed_at nullable: true properties: created_at: type: string description: When the reconfirmation was created. format: date-time example: '2020-11-23T17:51:18.341657Z' confirmed_at: type: string description: When the Invitee confirmed their attendance. format: date-time example: '2020-11-23T17:51:18.341657Z' nullable: true scheduling_method: type: string description: The method used to schedule the event enum: - instant_book - api nullable: true invitee_scheduled_by: type: string format: uri description: Reference to user URI who scheduled the event nullable: true scheduled_event: type: object description: Information about the invitee's scheduled meeting properties: uri: type: string format: uri description: Canonical reference (unique identifier) for the resource example: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: type: string description: The event name example: 15 Minute Meeting nullable: true meeting_notes_plain: type: string description: The event's meeting notes (in non formatted text) example: 15 Minute Meeting nullable: true meeting_notes_html: type: string description: The event's meeting notes (formatted with HTML) example:15 Minute Meeting
status: type: string enum: - active - canceled description: Indicates if the event is "active" or "canceled" start_time: type: string format: date-time description: 'The moment the event was scheduled to start in UTC time (e.g. "2020-01-02T03:04:05.678123Z").' end_time: type: string format: date-time description: 'The moment the event was scheduled to end in UTC time (e.g. "2020-01-02T03:04:05.678123Z")' event_type: type: string description: The event type associated with this event format: uri example: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: $ref: '#/components/schemas/Location' invitees_counter: type: object required: - total - active - limit properties: total: type: number description: 'Total invitees for an event, including invitees that have canceled' active: type: number description: Total invitees for an event that have not canceled limit: type: number description: Maximum number of active invitees that can book the event created_at: type: string format: date-time description: 'The moment when the event was created (e.g. "2020-01-02T03:04:05.678123Z")' example: '2019-01-02T03:04:05.678123Z' updated_at: type: string format: date-time description: 'The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")' example: '2019-01-02T03:04:05.678123Z' event_memberships: type: array description: Event membership list items: type: object properties: user: type: string format: uri description: Canonical reference (unique identifier) for the user example: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: type: string format: email description: The user's email example: user@example.com user_name: type: string description: The user's name example: John Smith required: - user event_guests: type: array description: Additional people added to an event by an invitee items: $ref: '#/components/schemas/Guest' cancellation: $ref: '#/components/schemas/Cancellation' required: - uri - name - status - start_time - end_time - event_type - location - invitees_counter - created_at - updated_at - event_memberships - event_guests required: - uri - email - first_name - last_name - name - status - questions_and_answers - timezone - event - created_at - updated_at - tracking - text_reminder_number - rescheduled - old_invitee - new_invitee - cancel_url - reschedule_url - routing_form_submission - payment - no_show - reconfirmation - scheduled_event - scheduling_method - invitee_scheduled_by x-internal: false WebhookSubscription: x-tags: - Webhooks title: Webhook Subscription type: object description: Webhook Subscription Object x-examples: Example: uri: 'https://api.calendly.com/webhook_subscriptions/AAAAAAAAAAAAAAAA' callback_url: 'https://blah.foo/bar' created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' retry_started_at: '2019-08-24T14:15:22.123456Z' state: active events: - invitee.created scope: user organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' user: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' creator: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' required: - uri - callback_url - created_at - updated_at - retry_started_at - state - events - scope - organization - user - group - creator properties: uri: type: string description: Canonical reference (unique identifier) for the webhook format: uri example: 'https://api.calendly.com/webhook_subscriptions/AAAAAAAAAAAAAAAA' callback_url: type: string description: The callback URL to use when the event is triggered format: uri example: 'https://blah.foo/bar' created_at: type: string description: 'The moment when the webhook subscription was created (e.g. "2020-01-02T03:04:05.678123Z")' format: date-time updated_at: type: string description: 'The moment when the webhook subscription was last updated (e.g. "2020-01-02T03:04:05.678123Z")' format: date-time retry_started_at: type: string description: The date and time the webhook subscription is retried format: date-time nullable: true state: type: string description: Indicates if the webhook subscription is "active" or "disabled" enum: - active - disabled events: type: array description: A list of events to which the webhook is subscribed uniqueItems: true items: type: string enum: - invitee.created - invitee.canceled - invitee_no_show.created - invitee_no_show.deleted - meeting_recap.created - meeting_recap.updated - meeting_recap.deleted - routing_form_submission.created - contact.created - contact.updated - contact.deleted scope: type: string enum: - user - organization - group description: The scope of the webhook subscription example: user organization: type: string description: The URI of the organization that's associated with the webhook subscription format: uri example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' user: type: string description: The URI of the user that's associated with the webhook subscription format: uri example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' nullable: true group: x-stoplight: id: tqqgkckt9jxcu example: 'https://api.calendly.com/groups/AAAAAAAAAAAAAAAA' type: string format: uri nullable: true creator: type: string format: uri description: The URI of the user who created the webhook subscription example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' nullable: true WebhookPayload: x-tags: - Webhooks title: Webhook Payload type: object description: Webhook Payload Object x-examples: Invitee Created: created_at: '2020-11-23T17:51:19.000000Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: invitee.created payload: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: John Doe new_invitee: null old_invitee: null questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: active text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:51:18.341657Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' scheduled_event: uri: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: 15 Minute Meeting meeting_notes_plain: Internal meeting notes meeting_notes_html:Internal meeting notes
status: active start_time: '2019-08-24T14:15:22.123456Z' end_time: '2019-08-24T14:15:22.123456Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: string additional_info: string invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-01-02T03:04:05.678123Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith event_guests: - email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' Invitee Canceled: created_at: '2020-11-23T17:54:22.000000Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: invitee.canceled payload: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: John Doe new_invitee: null old_invitee: null questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: canceled text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:54:22.356897Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' cancellation: canceled_by: John Doe reason: Meeting Conflict canceler_type: invitee created_at: '2020-11-23T17:54:22.356897Z' scheduled_event: uri: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: 15 Minute Meeting meeting_notes_plain: Internal meeting notes meeting_notes_html:Internal meeting notes
status: active start_time: '2019-08-24T14:15:22.123456Z' end_time: '2019-08-24T14:15:22.123456Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: string additional_info: string invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-01-02T03:04:05.678123Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith event_guests: - email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' Invitee No Show: created_at: '2020-11-23T17:51:19.000000Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: invitee_no_show.created payload: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: John Doe new_invitee: null old_invitee: null no_show: uri: 'https://api.calendly.com/invitee_no_shows/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.341657Z' questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: active text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:51:18.341657Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' scheduled_event: uri: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: 15 Minute Meeting meeting_notes_plain: Internal meeting notes meeting_notes_html:Internal meeting notes
status: active start_time: '2019-08-24T14:15:22.123456Z' end_time: '2019-08-24T14:15:22.123456Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: string additional_info: string invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-01-02T03:04:05.678123Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith event_guests: - email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' Invitee No Show Deleted: created_at: '2020-11-23T17:51:19.000000Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: invitee_no_show.deleted payload: cancel_url: 'https://calendly.com/cancellations/AAAAAAAAAAAAAAAA' created_at: '2020-11-23T17:51:18.327602Z' email: test@example.com event: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: John Doe new_invitee: null old_invitee: null questions_and_answers: [] reschedule_url: 'https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA' rescheduled: false status: active text_reminder_number: null timezone: America/New_York tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null updated_at: '2020-11-23T17:51:18.341657Z' uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' scheduled_event: uri: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2' name: 15 Minute Meeting meeting_notes_plain: Internal meeting notes meeting_notes_html:Internal meeting notes
status: active start_time: '2019-08-24T14:15:22.123456Z' end_time: '2019-08-24T14:15:22.123456Z' event_type: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' location: type: physical location: string additional_info: string invitees_counter: total: 0 active: 0 limit: 0 created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-01-02T03:04:05.678123Z' event_memberships: - user: 'https://api.calendly.com/users/GBGBDCAADAEDCRZ2' user_email: user@example.com user_name: John Smith event_guests: - email: user@example.com created_at: '2019-08-24T14:15:22.123456Z' updated_at: '2019-08-24T14:15:22.123456Z' Routing Form Submission Created: event: routing_form_submission.created created_at: '2022-05-15T14:59:59.000000Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' payload: uri: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' routing_form: 'https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA' questions_and_answers: - question_uuid: 123e4567-e89b-12d3-a456-426614174000 question: What is your industry? answer: IT & Software tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null result: type: event_type value: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' submitter: 'https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' submitter_type: Invitee created_at: '2022-05-15T03:04:05.678Z' updated_at: '2022-05-15T06:05:04.321Z' Contact Created: created_at: '2026-01-15T18:01:10Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: contact.created payload: user_uuid: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee contact: uri: 'https://api.calendly.com/contacts/CCCCCCCCCCCCCCCC' creation_source: calendly_api name: Jane Doe emails: - email: jane.doe@example.com is_primary: true - email: jane.alt@example.com is_primary: false phone_numbers: - phone_number: +1-404-555-0199 - phone_number: +1-405-554-0199 timezone: America/Los_Angeles job_title: Director of Operations company: ExampleCo country: US state: CA city: San Francisco linkedin: 'https://www.linkedin.com/in/janedoe' created_at: '2026-01-15T18:01:09Z' updated_at: '2026-01-15T18:01:09Z' next_meeting_date: null last_meeting_date: null last_interaction_date: null Contact Updated: created_at: '2026-01-15T18:05:10Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: contact.updated payload: user_uuid: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee contact: uri: 'https://api.calendly.com/contacts/CCCCCCCCCCCCCCCC' creation_source: calendly_api name: Jane Doe emails: - email: jane.doe@example.com is_primary: true - email: jane.alt@example.com is_primary: false phone_numbers: - phone_number: +1-404-555-0199 - phone_number: +1-405-554-0199 timezone: America/Los_Angeles job_title: Director of Operations company: ExampleCo country: US state: CA city: San Francisco linkedin: 'https://www.linkedin.com/in/janedoe' created_at: '2026-01-15T18:01:09Z' updated_at: '2026-01-15T18:05:00Z' next_meeting_date: '2026-01-20T15:00:00.000Z' last_meeting_date: '2026-01-10T14:00:00.000Z' last_interaction_date: '2026-01-12T09:30:00.000Z' Contact Deleted: created_at: '2026-05-06T13:35:50.580Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: contact.deleted payload: user_uuid: b0af0294-9ec5-4eca-af5b-86d7d572955a contact: uri: 'https://api.calendly.com/contacts/2f0b75c3-9489-4426-a239-10c7382faab2' deleted_at: '2026-05-06T13:35:50.580Z' Meeting Recap Created: created_at: '2025-01-15T18:01:10Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: meeting_recap.created payload: created_at: '2025-01-15T18:01:09Z' event: uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: 15 Minute Meeting start_time: '2025-01-15T14:00:00Z' end_time: '2025-01-15T14:15:00Z' location: type: physical location: Calendly Office attendees: - host: true user_name: John Smith user_email: john@example.com - host: false user_name: Steve Johnson user_email: steve@example2.com recap: uri: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB' summary_md: We aligned on Q4 goals and owners. action_items_md: |- - Send follow-up notes - Create project board discussion_md: Reviewed roadmap tradeoffs and dependencies. transcript: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB/transcript' share_link: 'https://calendly.com/s/meetings/320da85f-b2b2-45fc-a092-02a26b5a4738' created_at: '2025-01-15T18:01:09Z' updated_at: '2025-01-15T18:01:09Z' Meeting Recap Updated: created_at: '2025-01-15T18:05:22Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: meeting_recap.updated payload: event: uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: 15 Minute Meeting start_time: '2025-01-15T14:00:00Z' end_time: '2025-01-15T14:15:00Z' location: type: physical location: Calendly Office attendees: - host: true user_name: John Smith user_email: john@example.com - host: false user_name: Steve Johnson user_email: steve@example2.com recap: uri: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB' summary_md: Updated summary after review. action_items_md: '- Create Jira epic' discussion_md: Shortened notes transcript: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB/transcript' share_link: 'https://calendly.com/s/meetings/320da85f-b2b2-45fc-a092-02a26b5a4738' created_at: '2025-01-15T18:01:09Z' updated_at: '2025-01-15T18:05:00Z' Meeting Recap Deleted: created_at: '2025-08-24T20:10:42Z' created_by: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' event: meeting_recap.deleted payload: event: uri: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' recap: uri: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB' deleted_at: '2025-08-24T20:10:42Z' required: - event - created_at - created_by - payload properties: event: 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 description: The event that caused the webhook to fire created_at: type: string description: 'The moment when the event was created (e.g. "2020-01-02T03:04:05.678123Z")' format: date-time created_by: type: string description: The user who created the webhook format: uri example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA' payload: oneOf: - $ref: '#/components/schemas/InviteePayload' - $ref: '#/components/schemas/RoutingFormSubmission' - $ref: '#/components/schemas/EventTypePayload' - $ref: '#/components/schemas/ContactCreatedWebhookPayload' - $ref: '#/components/schemas/ContactUpdatedWebhookPayload' - $ref: '#/components/schemas/ContactDeletedWebhookPayload' - $ref: '#/components/schemas/MeetingRecapCreatedWebhookPayload' - $ref: '#/components/schemas/MeetingRecapUpdatedWebhookPayload' - $ref: '#/components/schemas/MeetingRecapDeletedWebhookPayload' description: |- The payload for the webhook event. The data in the payload depends on the event. For example, an `invitee.*` event produces an `Invitee` object in the payload. InviteeNoShow: title: InviteeNoShow type: object description: Information about an invitees no show. x-examples: Example: uri: 'https://api.calendly.com/no_shows/40a3cb54-e45c-4f34-b100-bd346220a5bb' invitee: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2/invitees/7c1dbe46-bd84-42e2-9b97-05e2fb379bfe' created_at: '2019-01-02T03:04:05.678123Z' x-tags: - Scheduled Events properties: uri: type: string format: uri example: 'https://api.calendly.com/invitee_no_shows/6ee96ed4-83a3-4966-a278-cd19b3c02e09' description: Canonical reference (unique identifier) for the no show invitee: type: string format: uri example: 'https://api.calendly.com/scheduled_events/e7cb69b9-8f2a-4008-99b5-22ddbc02a2bc/invitees/e5fdc32a-e2e3-4bcf-82d3-ecf098280aaa' description: Canonical reference (unique identifier) for the associated Invitee created_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: The moment when the no show was created required: - uri - invitee - created_at Group: title: Group type: object x-internal: false x-tags: - Groups description: The Group resource that was requested. Represents groupings of Users within an Organization. x-examples: sample-group: uri: 'https://api.calendly.com/groups/AAAAAAAAAAAAAAAA' name: Sales Team organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' created_at: '2019-01-02T03:04:05.678123Z' updated_at: '2019-08-07T06:05:04.321123Z' required: - uri - name - organization - created_at - updated_at properties: uri: type: string format: uri example: 'https://api.calendly.com/groups/AAAAAAAAAAAAAAAA' description: Canonical reference (unique identifier) for the Group resource name: type: string example: Sales Team description: The Group name (in human-readable format) organization: type: string format: uri example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' description: A unique reference to the associated Organization object created_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: The moment when the Group record was created updated_at: type: string format: date-time example: '2019-08-07T06:05:04.321123Z' description: The moment when the Group record was last updated member_count: type: number x-stoplight: id: xun6k7wp5tegx OrganizationMembershipOwner: x-internal: false allOf: - type: object properties: type: type: string enum: - OrganizationMembership - $ref: '#/components/schemas/OrganizationMembership' required: - type GroupRelationship: x-internal: false title: GroupRelationship description: 'A group relationship record for an individual. A given individual may have more than one admin relationship to multiple groups, but only one member relationship to a single group.' type: object x-tags: - Groups properties: uri: type: string format: uri description: Canonical reference (unique identifier) for the group relationship example: 'https://api.calendly.com/group_relationships/AAAAAAAAAAAAAAAA' role: type: string description: The user's role in the group - this value can only be 'member' or 'admin' example: member owner: type: object oneOf: - $ref: '#/components/schemas/OrganizationMembershipOwner' - $ref: '#/components/schemas/OrganizationInvitationOwner' organization: type: string description: The unique reference to the organization that the group relationship is tied to. format: uri example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' group: type: string description: The unique reference to the group that the group relationship is tied to. format: uri example: 'https://api.calendly.com/groups/AAAAAAAAAAAAAAAA' created_at: type: string format: date-time example: '2019-01-02T03:04:05.678123Z' description: 'The moment when the group relationship record was created (e.g. "2020-01-02T03:04:05.678123Z")' updated_at: type: string format: date-time example: '2019-08-07T06:05:04.321123Z' description: 'The moment when the group relationship record was last updated (e.g. "2020-01-02T03:04:05.678123Z")' required: - uri - role - owner - organization - group - updated_at - created_at OrganizationInvitationOwner: x-internal: false allOf: - type: object properties: type: type: string enum: - OrganizationInvitation - $ref: '#/components/schemas/OrganizationInvitation' required: - type RoutingForm: title: Routing Form x-stoplight: id: f7bpu3llb2u61 type: object description: Information about a routing form. x-tags: - Routing Forms x-examples: Example: uri: 'https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA' organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' name: ACME Routing Form status: published questions: - uuid: 123e4567-e89b-12d3-a456-426614174000 name: What is your industry? type: select required: true answer_choices: - IT & Software - Financial Services - Entertainment - uuid: 1213f8f1-57fd-45ee-88e9-1978d35b5cad name: Email type: email required: true answer_choices: null created_at: '2022-05-15T03:04:05.678Z' updated_at: '2022-05-15T06:05:04.321Z' x-internal: false properties: uri: type: string format: uri example: 'https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA' description: | Canonical reference (unique identifier) for the routing form. organization: type: string format: uri example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA' description: The URI of the organization that's associated with the routing form. name: type: string description: The routing form name (in human-readable format). example: ACME Demo status: type: string enum: - draft - published description: Indicates if the form is in "draft" or "published" status. questions: type: array description: An ordered collection of Routing Form non-deleted questions. items: $ref: '#/components/schemas/Question' created_at: type: string format: date-time description: The moment the routing form was created. example: '2022-01-02T03:04:05.678123Z' updated_at: type: string format: date-time example: '2022-01-02T03:04:05.678123Z' description: The moment when the routing form was last updated. required: - uri - organization - name - status - questions - created_at - updated_at RoutingFormSubmission: title: Routing Form Submission x-stoplight: id: 0h0yc6zqigbmt x-tags: - Routing Forms type: object x-internal: false x-examples: Example: uri: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' routing_form: 'https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA' questions_and_answers: - question_uuid: 123e4567-e89b-12d3-a456-426614174000 question: What is your industry? answer: IT & Software tracking: utm_campaign: null utm_source: null utm_medium: null utm_content: null utm_term: null salesforce_uuid: null result: type: event_type value: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2' submitter: 'https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' submitter_type: Invitee created_at: '2022-05-15T03:04:05.678Z' updated_at: '2022-05-15T06:05:04.321Z' description: Information about a Routing Form Submission. properties: uri: type: string description: Canonical reference (unique identifier) for the routing form submission. example: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA' format: uri routing_form: type: string format: uri example: 'https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA' description: The URI of the routing form that's associated with the submission. questions_and_answers: type: array description: All Routing Form Submission questions with answers. items: $ref: '#/components/schemas/SubmissionQuestionAndAnswer' tracking: $ref: '#/components/schemas/SubmissionTracking' result: $ref: '#/components/schemas/SubmissionResult' submitter: type: string example: 'https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA' description: The reference to the Invitee resource when routing form submission results in a scheduled meeting. format: uri nullable: true submitter_type: type: string enum: - Invitee description: Type of the respondent resource that submitted the form and scheduled a meeting. nullable: true created_at: type: string description: The moment the routing form was submitted. format: date-time example: '2022-01-02T03:04:05.678123Z' updated_at: type: string format: date-time example: '2022-01-02T03:04:05.678123Z' description: The moment when the routing form submission was last updated. required: - uri - routing_form - questions_and_answers - tracking - submitter - submitter_type - created_at - updated_at EventTypeAvailableTime: x-tags: - Event Types type: object description: An available meeting time slot for the given event type title: Event Type Available Time x-examples: Example: status: available invitees_remaining: 2 start_time: '2020-01-02T20:00:00.000000Z' scheduling_url: 'https://calendly.com/acmesales/discovery-call/2020-01-02T20:00:00Z?month=2020-01&date=2020-01-02' properties: status: type: string description: Indicates that the open time slot is "available" example: available invitees_remaining: type: number description: 'Total remaining invitees for this available time. For Group Event Type, more than one invitee can book in this available time. For all other Event Types, only one invitee can book in this available time.' example: 2 start_time: type: string format: date-time description: The moment the event was scheduled to start in UTC time example: '2020-01-02T20:00:00.000000Z' scheduling_url: type: string description: The URL of the user’s scheduling site where invitees book this event type format: uri example: 'https://calendly.com/acmesales/discovery-call/2020-01-02T20:00:00Z?month=2020-01&date=2020-01-02' required: - status - invitees_remaining - start_time - scheduling_url LocationConfiguration: title: LocationConfiguration x-stoplight: id: 7vwr4rsld2j8d x-tags: - Event Types type: object description: A configuration for an EventType's location x-examples: example-1: kind: zoom_conference x-internal: false nullable: true properties: kind: type: string enum: - ask_invitee - custom - google_conference - gotomeeting_conference - inbound_call - microsoft_teams_conference - outbound_call - physical - webex_conference - zoom_conference location: type: string additional_info: type: string phone_number: type: string Share: x-tags: - Shares type: object title: Share x-stoplight: id: zose6j0ewnsfa x-internal: false x-examples: example-1: scheduling_links: - booking_url: 'https://calendly.com/d/abcd-brv8/15-minute-meeting' owner: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' owner_type: EventType share_override: name: 15 Minute Meeting duration: 15 duration_options: - 1 - 13 - 15 - 720 period_type: available_moving start_date: '2019-01-02' end_date: '2019-01-03' max_booking_time: 300 hide_location: true location_configurations: - location: 123 Abc St. additional_info: Example additional info phone_number: +1 888-888-8888 position: 0 kind: physical availability_rule: rules: - type: wday wday: sunday date: '2019-01-02' intervals: - from: '07:00' to: '11:00' timezone: America/New_York properties: scheduling_links: type: array items: type: object properties: booking_url: type: string example: 'https://calendly.com/d/abcd-brv8/15-minute-meeting' format: uri description: Scheduling link url owner: type: string format: uri example: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA' description: 'A link to the resource that owns this Scheduling Link (currently, this is always an Event Type)' owner_type: type: string example: EventType enum: - EventType description: 'Resource type (currently, this is always EventType)' required: - booking_url share_override: type: object properties: name: type: string maxLength: 55 example: 15 Minute Meeting duration: example: 15 type: integer duration_options: type: array items: type: integer example: - 1 - 13 - 15 - 720 nullable: true period_type: type: string enum: - available_moving - moving - fixed - unlimited example: fixed start_date: type: string format: date example: '2019-01-02' description: 'Format: `YYYY-MM-DD`' nullable: true end_date: type: string format: date example: '2019-01-03' description: 'Format: `YYYY-MM-DD`' nullable: true max_booking_time: type: integer example: 300 nullable: true hide_location: type: boolean nullable: true location_configurations: type: array items: type: object properties: location: type: string maxLength: 255 example: 123 Abc St. nullable: true additional_info: type: string example: Example additional info maxLength: 255 nullable: true phone_number: type: string example: +1 888-888-8888 nullable: true position: type: integer example: 0 kind: type: string example: physical enum: - physical - ask_invitee - custom - outbound_call - inbound_call - google_conference - gotomeeting_conference - microsoft_teams_conference - zoom_conference availability_rule: type: object properties: rules: type: array items: type: object properties: type: type: string enum: - wday - date example: wday wday: type: string example: friday enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday date: type: string format: date example: '2019-01-02' description: 'Format: `YYYY-MM-DD`' intervals: type: array items: type: object properties: from: type: string description: 'Format: `"hh:mm"`' example: '07:00' pattern: '(\d\d):(\d\d)' to: type: string description: 'Format: `"hh:mm"`' example: '11:00' pattern: '(\d\d):(\d\d)' required: - type timezone: type: string example: America/New_York required: - rules - timezone required: - scheduling_links - share_override UserBusyTime: x-internal: false x-tags: - Availability type: object title: User Busy Time description: An internal or external scheduled event for a given user x-examples: Example: type: calendly start_time: '2020-01-02T20:00:00.000000Z' end_time: '2020-01-02T20:30:00.000000Z' buffered_start_time: '2020-01-02T19:30:00.000000Z' buffered_end_time: '2020-01-02T21:00:00.000000Z' event: uri: 'https://api.calendly.com/scheduled_events/abc123' properties: type: type: string description: Indicates whether the scheduled event is internal ('calendly' or 'reserved') or external enum: - calendly - reserved - external example: calendly start_time: type: string format: date-time description: The start time of the scheduled event in UTC time example: '2020-01-02T20:00:00.000000Z' end_time: type: string format: date-time description: The end time of the scheduled event in UTC time example: '2020-01-02T20:30:00.000000Z' buffered_start_time: type: string format: date-time description: 'The start time of the calendly event, as calculated by any "before" buffer set by the user' example: '2020-01-02T19:30:00.000000Z' buffered_end_time: type: string format: date-time description: 'The end time of the calendly event, as calculated by any "after" buffer set by the user' example: '2020-01-02T21:00:00.000000Z' event: type: object required: - uri properties: uri: type: string format: uri description: The uri associated with the calendly scheduled event required: - type - start_time - end_time AvailabilitySchedule: title: User Availability Schedule x-stoplight: id: nd8xy6bxygyiq type: object description: The availability schedule set by the user. x-examples: Example: uri: 'https://api.calendly.com/user_availability_schedule/abc123' default: true name: Working Hours user: 'https://api.calendly.com/users/abc123' rules: - type: wday intervals: - from: '08:30' to: '17:00' wday: monday - type: wday intervals: - from: '08:30' to: '17:00' wday: tuesday - type: wday intervals: [] wday: wednesday - type: wday intervals: - from: '08:30' to: '17:00' wday: thursday - type: wday intervals: - from: '08:30' to: '17:00' wday: friday - type: wday intervals: [] wday: saturday - type: date intervals: - from: '08:30' to: '09:30' date: '2028-12-31' timezone: America\/New_York x-tags: - Availability properties: uri: type: string format: uri example: 'https://api.calendly.com/user_availability_schedule/abc123' description: A URI reference to this Availability Schedule. default: type: boolean description: This is the default Availability Schedule in use. name: type: string example: Working Hours description: The name of this Availability Schedule. user: type: string format: uri example: 'https://api.calendly.com/users/abc123' description: A URI reference to a User. timezone: type: string example: America/New_York description: The timezone for which this Availability Schedule is originated in. rules: type: array description: The rules of this Availability Schedule. items: $ref: '#/components/schemas/AvailabilityRule' required: - uri - default - name - user - timezone - rules x-internal: false AvailabilityRule: title: Availability Rule x-stoplight: id: a1hurebl7s3c6 type: object x-examples: wday: type: wday intervals: - from: '08:30' to: '09:30' wday: sunday date: type: date intervals: - from: '08:30' to: '09:30' date: '2028-12-31' x-internal: false description: The rules for an availability schedule. x-tags: - Availability required: - type - intervals properties: type: type: string enum: - wday - date example: wday description: The type of this Availability Rule; can be "wday" or a specific "date". intervals: type: array description: 'The intervals to be applied to this Rule. Each interval represents when booking a meeting is allowed. If the interval array is empty, then there is no booking availability for that day. Time is in 24h format (i.e. "17:30") and local to the timezone in the Availability Schedule.' items: type: object properties: from: type: string description: 'Format: `"hh:mm"`' pattern: '(\d\d):(\d\d)' example: '08:30' to: type: string description: 'Format: `"hh:mm"`' pattern: '(\d\d):(\d\d)' example: '09:30' wday: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday description: The day of the week for which this Rule should be applied to. date: type: string example: '2022-12-31' pattern: '^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$' description: A specific date in the future that this should be applied to (i.e. "2030-12-31"). Holiday: title: Holiday x-stoplight: id: o0foduny3sq56 type: object description: Representation of a supported holiday properties: key: type: string description: Unique identifier for each holiday. Contains country code and abbreviated reference of the holiday name name: type: string date_actual: type: string description: 'Date the holiday falls on ' format: date example: '2023-11-11' date_observed: type: string description: Date that the holiday is observed. This is the date that availability will be affected by this holiday. format: date example: '2023-11-10' required: - key - name - date_actual - date_observed MeetingLocation: title: MeetingLocation x-tags: - Locations type: object description: A configuration for an EventType's location x-examples: Example: kind: zoom_conference connected: true x-internal: false nullable: true properties: kind: type: string description: The type of location configuration enum: - ask_invitee - custom - google_conference - gotomeeting_conference - inbound_call - microsoft_teams_conference - outbound_call - physical - webex_conference - zoom_conference example: zoom_conference connected: type: boolean description: Indicates if the location configuration is connected (only valid for web conferencing) example: true required: - kind Contact: title: Contact x-stoplight: id: 5uu53x6ojn1bz type: object description: Information about a contact. x-tags: - Contacts x-internal: false required: - uri - emails - created_at - updated_at properties: uri: type: string x-stoplight: id: vee753k8tkyh1 format: uri example: 'https://api.calendly.com/contacts/CCCCCCCCCCCCCCCC' description: Canonical reference (unique identifier) for the contact. emails: type: array maxItems: 10 x-stoplight: id: b3fhiw1cdo7cq description: The user's email addresses. Max 10. items: $ref: '#/components/schemas/Email' name: type: string x-stoplight: id: tr95cah4di7u3 description: The user's name (human-readable format). example: Jane Doe nullable: true phone_numbers: type: array maxItems: 10 x-stoplight: id: efmu60mul2xt8 description: The user's phone numbers. Max 10. items: $ref: '#/components/schemas/PhoneNumber' timezone: type: string x-stoplight: id: 14kw8galpz3f9 description: The time zone to use when presenting time to the user. example: America/Los_Angeles nullable: true job_title: type: string x-stoplight: id: nonh746rj83b9 description: The user's job title. example: Director of Operations nullable: true company: type: string x-stoplight: id: pq6r9565mf3cu description: The user's company name. example: ExampleCo nullable: true country: type: string x-stoplight: id: a875yn97jzu99 example: US description: The user's two letter country code. *(ISO 3166-1 alpha-2)* nullable: true state: type: string x-stoplight: id: mghuz4c3ivbf4 example: CA description: 'The user''s state, province, or region.' nullable: true city: x-stoplight: id: ribmlt9fv3zps description: The user's city. example: San Francisco type: string nullable: true linkedin: type: string x-stoplight: id: s0x5kkvmhgu8c format: uri description: The URL of the user's LinkedIn profile. example: 'https://www.linkedin.com/in/janedoe' nullable: true custom_fields: x-fern-ignore: true type: array description: The contact's custom field values. items: type: object x-sl-internally-excluded: true x-sl-error-message: You do not have permission to view this reference created_at: type: string x-stoplight: id: xikhfaklp0f5d format: date-time example: '2026-01-15T18:01:09Z' description: 'The moment the user''s record was created (e.g. "2026-01-15T18:01:09Z")' updated_at: type: string x-stoplight: id: su5wwi1lx300a format: date-time example: '2026-01-15T18:01:09Z' description: 'The moment the user''s record was last updated (e.g. "2026-01-15T18:01:09Z")' first_email_date: type: string format: date-time example: '2026-01-08T11:00:00.000Z' description: The timestamp of the earliest email exchanged with the contact. Always `null` immediately after a contact is created. nullable: true last_email_date: type: string format: date-time example: '2026-01-08T11:00:00.000Z' description: The timestamp of the most recent email exchanged with the contact. Always `null` immediately after a contact is created. nullable: true next_meeting_date: type: string format: date-time example: '2026-01-08T11:00:00.000Z' description: The timestamp of the next upcoming meeting scheduled with the contact. Always `null` immediately after a contact is created. nullable: true last_meeting_date: type: string format: date-time example: '2026-01-08T11:00:00.000Z' description: The timestamp of the most recent meeting held with the contact. Always `null` immediately after a contact is created. nullable: true last_interaction_date: type: string format: date-time example: '2026-01-08T11:00:00.000Z' description: The timestamp of the most recent interaction (email or meeting) with the contact. Always `null` immediately after a contact is created. nullable: true ContactCreatedWebhookPayload: title: Contact created webhook payload type: object description: Payload for `contact.created` (`user_uuid` plus `contact`) x-internal: false required: - user_uuid - contact properties: user_uuid: type: string format: uuid description: User unique identifier example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee contact: type: object description: Contact record for this event. required: - uri - creation_source - emails - name - created_at - updated_at - next_meeting_date - last_meeting_date - last_interaction_date properties: uri: type: string format: uri example: 'https://api.calendly.com/contacts/CCCCCCCCCCCCCCCC' description: Contact resource URI creation_source: type: string description: How the contact was created example: calendly_api name: type: string description: Contact display name example: Jane Doe emails: type: array maxItems: 10 description: The users' email addresses. Max 10. items: $ref: '#/components/schemas/Email' phone_numbers: type: array maxItems: 10 description: The users' phone numbers. Max 10. items: $ref: '#/components/schemas/PhoneNumber' timezone: type: string description: IANA time zone name example: America/Los_Angeles nullable: true job_title: type: string description: Job title example: Director of Operations nullable: true company: type: string description: Company name example: ExampleCo nullable: true country: type: string description: Country code or name example: US nullable: true state: type: string description: State or region example: CA nullable: true city: type: string description: City example: San Francisco nullable: true linkedin: type: string format: uri description: LinkedIn profile URL example: 'https://www.linkedin.com/in/janedoe' nullable: true created_at: type: string format: date-time example: '2026-01-15T18:01:09Z' description: Timestamp when the contact was created updated_at: type: string format: date-time example: '2026-01-15T18:01:09Z' description: Timestamp when the contact was last updated next_meeting_date: type: string format: date-time nullable: true description: 'Start time of the next scheduled meeting from interaction summaries (ISO 8601), or null when unknown. Always null on `contact.created`.' last_meeting_date: type: string format: date-time nullable: true description: 'Start time of the most recent meeting from interaction summaries (ISO 8601), or null when unknown. Always null on `contact.created`.' last_interaction_date: type: string format: date-time nullable: true description: 'Timestamp of the most recent interaction from interaction summaries (ISO 8601), or null when unknown. Always null on `contact.created`.' first_email_date: type: string format: date-time nullable: true description: Earliest email interaction (ISO 8601). Always null on `contact.created`. last_email_date: type: string format: date-time nullable: true description: Latest email interaction (ISO 8601). Always null on `contact.created`. ContactUpdatedWebhookPayload: title: Contact updated webhook payload type: object description: Payload for `contact.updated` (`user_uuid` plus `contact`). x-internal: false required: - user_uuid - contact properties: user_uuid: type: string format: uuid description: User unique identifier example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee contact: type: object description: Contact record for this event. required: - uri - creation_source - emails - name - created_at - updated_at - next_meeting_date - last_meeting_date - last_interaction_date properties: uri: type: string format: uri example: 'https://api.calendly.com/contacts/CCCCCCCCCCCCCCCC' description: Contact resource URI creation_source: type: string description: How the contact was created example: calendly_api name: type: string description: Contact display name example: Jane Doe emails: type: array maxItems: 10 description: The users' email addresses. Max 10. items: $ref: '#/components/schemas/Email' phone_numbers: type: array maxItems: 10 description: The users' phone numbers. Max 10. items: $ref: '#/components/schemas/PhoneNumber' timezone: type: string description: IANA time zone name example: America/Los_Angeles nullable: true job_title: type: string description: Job title example: Director of Operations nullable: true company: type: string description: Company name example: ExampleCo nullable: true country: type: string description: Country code or name example: US nullable: true state: type: string description: State or region example: CA nullable: true city: type: string description: City example: San Francisco nullable: true linkedin: type: string format: uri description: LinkedIn profile URL example: 'https://www.linkedin.com/in/janedoe' nullable: true created_at: type: string format: date-time example: '2026-01-15T18:01:09Z' description: Timestamp when the contact was created updated_at: type: string format: date-time example: '2026-01-15T18:01:09Z' description: Timestamp when the contact was last updated next_meeting_date: type: string format: date-time nullable: true description: 'Start time of the next scheduled meeting from interaction summaries (ISO 8601), or null when unknown. Null when unknown.' last_meeting_date: type: string format: date-time nullable: true description: 'Start time of the most recent meeting from interaction summaries (ISO 8601), or null when unknown. Null when unknown.' last_interaction_date: type: string format: date-time nullable: true description: 'Timestamp of the most recent interaction from interaction summaries (ISO 8601), or null when unknown. Null when unknown.' first_email_date: type: string format: date-time nullable: true description: Earliest email interaction (ISO 8601). Null when unknown. last_email_date: type: string format: date-time nullable: true description: Latest email interaction (ISO 8601). Null when unknown. ContactDeletedWebhookPayload: title: Contact deleted webhook payload type: object description: Payload for `contact.deleted` (`user_uuid` plus nested `contact` with `uri` and `deleted_at`). x-internal: false required: - user_uuid - contact properties: user_uuid: type: string format: uuid description: User unique identifier example: b0af0294-9ec5-4eca-af5b-86d7d572955a contact: type: object description: Deleted contact snapshot required: - uri - deleted_at properties: uri: type: string format: uri example: 'https://api.calendly.com/contacts/2f0b75c3-9489-4426-a239-10c7382faab2' description: Contact resource URI deleted_at: type: string format: date-time example: '2026-05-06T13:35:50.580Z' description: Timestamp when the contact was deleted MeetingRecapCreatedWebhookPayload: title: Meeting recap created webhook payload type: object additionalProperties: false description: V2 webhook payload for `meeting_recap.created` x-internal: false required: - created_at - event - recap properties: created_at: type: string format: date-time description: When the meeting recap was processed/completed. example: '2025-01-15T18:01:09Z' event: type: object description: Snapshot of the related scheduled event properties: uri: type: string format: uri description: Scheduled event resource URI (present when the event provider is Calendly) example: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: type: string example: 15 Minute Meeting start_time: type: string format: date-time example: '2025-01-15T14:00:00Z' end_time: type: string format: date-time example: '2025-01-15T14:15:00Z' location: $ref: '#/components/schemas/Location' attendees: type: array items: type: object required: - host - user_email - user_name properties: host: type: boolean user_email: type: string format: email user_name: type: string recap: type: object description: Meeting recap resource references and content additionalProperties: false required: - uri - transcript properties: uri: type: string format: uri description: Meeting recap resource URI example: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB' summary_md: type: string description: Markdown summary of the meeting action_items_md: type: string description: Markdown action items from the meeting discussion_md: type: string description: Markdown discussion points transcript: type: string format: uri description: Transcript resource URI example: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB/transcript' share_link: type: string format: uri description: Share link for the meeting recap example: 'https://calendly.com/s/meetings/320da85f-b2b2-45fc-a092-02a26b5a4738' created_at: type: string format: date-time description: When the meeting recap was created example: '2025-01-15T18:01:09Z' updated_at: type: string format: date-time description: When the meeting recap was last updated example: '2025-01-15T18:01:09Z' MeetingRecapUpdatedWebhookPayload: title: Meeting recap updated webhook payload type: object additionalProperties: false description: V2 webhook payload for `meeting_recap.updated` x-internal: false required: - event - recap properties: event: type: object description: Snapshot of the related scheduled event properties: uri: type: string format: uri description: Scheduled event resource URI (present when the event provider is Calendly) example: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' name: type: string example: 15 Minute Meeting start_time: type: string format: date-time example: '2025-01-15T14:00:00Z' end_time: type: string format: date-time example: '2025-01-15T14:15:00Z' location: $ref: '#/components/schemas/Location' attendees: type: array items: type: object required: - host - user_email - user_name properties: host: type: boolean user_email: type: string format: email user_name: type: string recap: type: object description: Updated meeting recap resource additionalProperties: false required: - uri properties: uri: type: string format: uri description: Meeting recap resource URI example: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB' summary_md: type: string description: Markdown summary of the meeting action_items_md: type: string description: Markdown action items from the meeting discussion_md: type: string description: Markdown discussion points transcript: type: string format: uri description: Transcript resource URI example: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB/transcript' share_link: type: string format: uri description: Share link for the meeting recap example: 'https://calendly.com/s/meetings/320da85f-b2b2-45fc-a092-02a26b5a4738' created_at: type: string format: date-time description: When the meeting recap was created example: '2025-01-15T18:01:09Z' updated_at: type: string format: date-time description: When the meeting recap was last updated example: '2025-01-15T18:05:00Z' MeetingRecapDeletedWebhookPayload: title: Meeting recap deleted webhook payload type: object additionalProperties: false description: V2 webhook payload for `meeting_recap.deleted` x-internal: false required: - recap properties: event: type: object description: Related scheduled event reference additionalProperties: false properties: uri: type: string format: uri description: Scheduled event resource URI (present when the event provider is Calendly) example: 'https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA' recap: type: object description: Deleted meeting recap resource reference additionalProperties: false required: - uri - deleted_at properties: uri: type: string format: uri description: Meeting recap resource URI example: 'https://api.calendly.com/meeting_recaps/BBBBBBBBBBBBBBBB' deleted_at: type: string format: date-time description: When the meeting recap was deleted example: '2025-08-24T20:10:42Z' Pagination: title: Pagination type: object x-examples: Example: 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 properties: count: type: integer minimum: 0 maximum: 100 description: The number of rows to return example: 20 next_page: type: string nullable: true format: uri description: URI to return the next page of an ordered list ("null" indicates no additional results are available) example: 'https://api.calendly.com/event_types?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi' previous_page: type: string nullable: true format: uri description: URI to return the previous page of an ordered list ("null" indicates no additional results are available) example: 'https://api.calendly.com/event_types?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H' next_page_token: type: string nullable: true description: Token to return the next page of an ordered list ("null" indicates no additional results are available) example: sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi previous_page_token: type: string nullable: true description: Token to return the previous page of an ordered list ("null" indicates no additional results are available) example: VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H required: - count - next_page - previous_page - next_page_token - previous_page_token ErrorResponse: title: Error Response type: object description: Error Object properties: title: type: string message: type: string details: type: array items: $ref: '#/components/schemas/ErrorResponseDetailsItem' required: - title - message ErrorResponseDetailsItem: title: ErrorResponseDetailsItem type: object properties: parameter: type: string message: type: string code: type: string required: - message InviteeLocation: 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. x-stoplight: id: qlv5rxzxptlnf nullable: true oneOf: - $ref: '#/components/schemas/InviteeInPersonMeeting' x-stoplight: id: zmuployxd322h - $ref: '#/components/schemas/InviteeInboundCall' x-stoplight: id: 7f84g3y7lzzt4 - $ref: '#/components/schemas/InviteeOutboundCall' x-stoplight: id: ibal773g6tnsd - $ref: '#/components/schemas/InviteeZoomConference' x-stoplight: id: xdivhetstrza9 - $ref: '#/components/schemas/InviteeGoogleConference' x-stoplight: id: uax6glctygt08 - $ref: '#/components/schemas/InviteeGotoMeetingConference' x-stoplight: id: gqeijdx6y7qie - $ref: '#/components/schemas/InviteeMicrosoftTeamsConference' x-stoplight: id: 9mvmkcc0wo895 - $ref: '#/components/schemas/InviteeWebExConference' x-stoplight: id: fw1f6opc258uj - $ref: '#/components/schemas/InviteeInviteeSpecifiedLocation' x-stoplight: id: 006ub7w1bwq13 - $ref: '#/components/schemas/InviteeCustomLocation' x-stoplight: id: l9wt8mtlzn6ji title: Invitee Location x-examples: Example: type: physical location: string type: object InviteeInPersonMeeting: title: Event In Person Meeting x-stoplight: id: 16ua8ugxz2moh type: object description: Information for an In Person Meeting required: - kind - location properties: kind: type: string x-stoplight: id: ljexxtnmzwqbv enum: - physical description: Indicates that the event will be an in-person meeting. location: type: string x-stoplight: id: qhw2elrlc0x2n description: The specific physical location InviteeInboundCall: title: Event Inbound Call x-stoplight: id: od554nc8402no type: object description: Information for an Inbound Call required: - kind properties: kind: type: string x-stoplight: id: 0gaylymrk1c2y enum: - inbound_call description: Indicates that the invitee will call the event host InviteeOutboundCall: title: Event Outbound Call x-stoplight: id: ia5g2e1jru9jl type: object description: Information about an Outbound Call required: - kind - location properties: kind: type: string x-stoplight: id: 07zf4gbcd2ohy enum: - outbound_call description: Indicates that the event host (publisher) will call the invitee location: type: string x-stoplight: id: 7mef3i1sj8apt description: The phone number the event host (publisher) will use to call the invitee InviteeZoomConference: title: Event Zoom Conference x-stoplight: id: tp1ntpjzxj04h type: object description: Information about a Zoom Conference required: - kind properties: kind: type: string x-stoplight: id: ldpmy3qcvns2w enum: - zoom_conference description: The event location is a Zoom conference InviteeGoogleConference: title: Event Google Conference x-stoplight: id: 0xqfme5zwm59m type: object description: Information for a Google Conference required: - kind properties: kind: type: string enum: - google_conference x-stoplight: id: kz5kzmrbpgvsb description: The event location is a Google Meet or Hangouts conference InviteeGotoMeetingConference: title: Event GotoMeeting Conference x-stoplight: id: 44yo3kqxgdu39 type: object description: Information for a GotoMeeting Conference required: - kind properties: kind: type: string x-stoplight: id: f123nka5sqrjz enum: - gotomeeting_conference description: The event location is a GoToMeeting conference InviteeMicrosoftTeamsConference: title: Event Microsoft Teams Conference x-stoplight: id: 3jdrepx58dttd type: object description: Information for a Microsoft Teams Conference required: - kind properties: kind: type: string x-stoplight: id: 1ete5xomqe280 enum: - microsoft_teams_conference description: The event location is a Microsoft Teams conference InviteeWebExConference: title: Event WebEx Conference x-stoplight: id: jazobk99zcjg1 type: object description: Information about a WebEx Conference required: - kind properties: kind: type: string x-stoplight: id: 8ty55m2o99vpq enum: - webex_conference description: The event location is a WebEx conference InviteeInviteeSpecifiedLocation: title: Event Invitee Specified Location x-stoplight: id: 4rlzj3zbxik96 type: object description: Information for an Invitee Specified Location required: - kind - location properties: kind: type: string x-stoplight: id: sbm7y380r93v8 enum: - ask_invitee description: Indicates that the event location will be selected by the invitee location: type: string x-stoplight: id: r0i0uaq4s8g2q description: The event location description provided by the invitee InviteeCustomLocation: title: Event Custom Location x-stoplight: id: uvd9gdlkz7mvw type: object description: Information for a Custom Location required: - kind - location properties: kind: type: string x-stoplight: id: txohay6699lpz enum: - custom description: The event location doesn't fall into a standard category defined by the event host (publisher) location: type: string x-stoplight: id: j6iyyl0lt03cw description: The specific custom location InviteeQuestionAndAnswer: title: Invitee Question and Answer x-stoplight: id: nwdrqy8z37ifp type: object x-examples: Checkbox Answer Type: answer: |- Answer 1 Answer 2 Answer 3 position: 0 question: Question 1 Multiple Lines Answer Type: answer: |- Multiple line Answer position: 1 question: Question 2 Phone Number Answer Type: answer: +1 234-567-8910 position: 2 question: Question 3 description: A response to a question on a booking page form. Required questions must be included in the body and match on the question string exactly. x-internal: false required: - question - answer - position properties: question: type: string description: A question for the invitee. String is case sensitive and must exactly match the question. x-stoplight: id: 662sqlr4wchz2 answer: type: string description: The invitee's response to the question x-stoplight: id: 684r3vdf0ygkp position: type: integer description: The position of the question in relation to others x-stoplight: id: izejtdhr5xz0i InviteeTracking: title: Invitee Tracking x-stoplight: id: nskvehpm18fx9 type: object x-examples: InviteeTracking: utm_campaign: UTM Campaign utm_source: UTM Source utm_medium: UTM Medium utm_content: UTM Content utm_term: UTM Term salesforce_uuid: 5003000000D8cuIQAA description: The UTM and Salesforce tracking parameters associated with an Invitee properties: utm_campaign: type: string nullable: true description: The UTM parameter used to track a campaign utm_source: type: string nullable: true description: The UTM parameter that identifies the source (platform where the traffic originates) utm_medium: type: string nullable: true description: 'The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social media, affiliate or QR code)' utm_content: type: string nullable: true description: UTM content tracking parameter utm_term: type: string nullable: true description: The UTM parameter used to track keywords salesforce_uuid: type: string nullable: true description: The Salesforce record unique identifier required: - utm_campaign - utm_source - utm_medium - utm_content - utm_term - salesforce_uuid Entry: title: Activity Log Entry description: Object for a created activity log record type: object properties: occurred_at: type: string format: date-time description: 'The date and time of the entry (format: "2020-01-02T03:04:05.678Z").' actor: $ref: '#/components/schemas/Actor' details: type: object fully_qualified_name: type: string minLength: 3 pattern: '^[A-Za-z0-9\-_]+\.[A-Za-z0-9\-_]+$' example: User.Add uri: type: string example: 'https://api.calendly.com/activity_log_entries/034bda29-a544-4dc9-9c55-2afbbb376811' namespace: type: string minLength: 1 pattern: '^[A-Za-z0-9\-_]+$' example: User action: type: string minLength: 1 pattern: '^[A-Za-z0-9\-_]+$' example: Add organization: type: string example: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAA' required: - action - details - fully_qualified_name - uri - namespace - occurred_at - organization example: uri: 'https://api.calendly.com/activity_log_entries/ALSKJCNELKJSDFLKJ' occurred_at: '2020-01-02T03:04:05.678Z' namespace: User action: Add actor: uri: 'https://api.calendly.com/users/SDLKJENFJKD123' type: User organization: uri: 'https://api.calendly.com/organizations/LKJENFLKE293847' role: Owner group: uri: 'https://api.calendly.com/groups/123987DJLKJEF' name: Development role: Admin display_name: Test User alternative_identifier: testuser@example.com details: event_name: 60 minute meeting fully_qualified_name: User.Add organization: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAA' Actor: title: Activity Log Actor type: object description: | The Calendly actor that took the action creating the activity log entry Specific actors: