Calendly API
Tools that enable LLMs to interact directly with the calendly API.
This documentation details the Arcade toolkit for integrating with the Calendly API, enabling developers to efficiently manage scheduling events and invitees.
Capabilities
- Create and cancel scheduled events as well as generate custom share links.
- Manage invitees by adding, removing, or marking their attendance status.
- Retrieve user and organization-specific information such as availability and event types.
- Set up webhook subscriptions for real-time notifications on event changes.
OAuth
- Provider: Calendly
- Scopes: None
Secrets
- None available in this toolkit.
Available tools(51)
| Tool name | Description | Secrets | |
|---|---|---|---|
Cancels a specified scheduled event on Calendly.
Use this tool to cancel a scheduled event by providing its unique identifier. It should be called when you need to remove an event from your calendar. | |||
Create a shareable link for a customized event.
Use this tool to generate a customized shareable link for one-on-one event types on Calendly. This tool should be called when you want to tailor event details for a specific invitee without creating a new event type. Note: Any details not specified will be inherited from the existing event.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a new event invitee on Calendly.
This tool is used to create a new event invitee on Calendly. It triggers standard notifications, calendar invites, reschedules, and workflows as if booked via the Calendly interface. Note that only users on paid Calendly plans can access this feature.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a new one-on-one event type in Calendly.
This tool is used to create a new one-on-one event type in Calendly. It is useful when scheduling personalized meetings or appointments.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a one-off event type in Calendly.
This tool is used to create a one-off event type in Calendly, allowing users to schedule unique events not linked to recurring event types.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Creates a single-use scheduling link for appointments. | |||
Create a webhook subscription for events in Calendly.
Use this tool to set up a webhook subscription for either an organization, user, or group. It triggers on specified events like invitee creation or cancellation. Useful for integrating Calendly events with other applications or systems. | |||
Request removal of invitee data from all booked events.
Use this tool to submit a request for deleting an invitee's data from all previously booked events within your organization. It requires an Enterprise subscription and can take up to 7 days to complete. | |||
Delete scheduled events data within a past time range.
Use this tool to request the deletion of scheduled events data for your organization within a specified past time range, up to 24 months. Completion may take up to 7 days. Requires an Enterprise subscription. | |||
Delete a webhook subscription on Calendly.
Use this tool to delete a specific webhook subscription from Calendly by providing the webhook UUID. | |||
Fetches a list of event type hosts from Calendly.
Use this tool to retrieve a list of hosts for event types on Calendly. This can be useful to determine availability or to manage event type assignments. | |||
Retrieve outgoing SMS and email communications.
Fetches a list of outgoing SMS and email communications for users with an Enterprise subscription. | |||
Retrieve user information from Calendly.
Call this tool to get detailed information about a specific Calendly user using their UUID. | |||
Retrieve availability for a specific event type.
This tool returns the availability schedule for a given event type. It should be called when you need to check open time slots for booking or planning purposes. | |||
Retrieve information about a specified scheduled event.
Use this tool to get details about a specific event scheduled in Calendly, using the event's unique identifier. | |||
Fetch information about a specific event invitee.
Use this tool to obtain detailed information about an invitee for a particular scheduled event on Calendly. Call this when you need specifics about a person invited to an event, identified by event and invitee UUIDs. | |||
Retrieve information about a specified event type on Calendly.
Use this tool to obtain detailed information about a specific event type by providing its unique identifier (UUID). It's useful for understanding the configuration and settings of different event types in your Calendly account. | |||
Retrieve information about a specified group in Calendly.
Use this tool to get detailed information about a specific group in Calendly by providing the group's UUID. | |||
Retrieve a list of groups from Calendly.
Use this tool to obtain information about the various groups available in Calendly. It returns a list detailing these groups. | |||
Retrieve group relationship details using a UUID.
This tool fetches the details of a group relationship in Calendly by using the unique identifier (UUID). Use it when you need to access specific group relationship information. | |||
Fetch details of a specified invitee no-show.
Use this tool to retrieve detailed information about an invitee who did not show up for a scheduled event. This is helpful for managing scheduling follow-ups or analyzing attendance patterns. | |||
Retrieve details of a specified organization using UUID.
Call this tool to obtain comprehensive information about an organization by providing its unique UUID. | |||
Fetches details of an organization's invitation.
Use this tool to retrieve information about an invitation sent within an organization to its members. This can help track invitation status and details. | |||
Retrieve details about a user's organization membership in Calendly.
Use this tool to get information about a specific user's membership within an organization on Calendly. This tool can be called when you need detailed membership data for a given user, identified by their unique UUID. | |||
Retrieve organization memberships and related details.
Use this tool to list the organization memberships for all users in an organization. You can also retrieve your organization's URI using this endpoint. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
CalendlyApi.CancelScheduledEvent
Cancels a specified scheduled event on Calendly. Use this tool to cancel a scheduled event by providing its unique identifier. It should be called when you need to remove an event from your calendar.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_unique_identifier | string | Required | The unique identifier for the event to be canceled. |
cancellation_reason | string | Optional | The reason for canceling the event. Provide a clear and concise explanation. |
Requirements
Output
json— Response from the API endpoint 'create-scheduled-event-cancellation'.CalendlyApi.CreateEventInvitee
Create a new event invitee on Calendly. This tool is used to create a new event invitee on Calendly. It triggers standard notifications, calendar invites, reschedules, and workflows as if booked via the Calendly interface. Note that only users on paid Calendly plans can access this feature. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-invitee'.CalendlyApi.CreateEventType
Create a new one-on-one event type in Calendly. This tool is used to create a new one-on-one event type in Calendly. It is useful when scheduling personalized meetings or appointments. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-event-type'.CalendlyApi.CreateOneOffEvent
Create a one-off event type in Calendly. This tool is used to create a one-off event type in Calendly, allowing users to schedule unique events not linked to recurring event types. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-one-off-event-type'.CalendlyApi.CreateSchedulingLink
Creates a single-use scheduling link for appointments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
maximum_event_count | number | Required | The maximum number of events that can be scheduled using this link. Currently, only '1' is supported. |
resource_owner_link | string | Required | A link to the resource owning this scheduling link, typically an Event Type URL. |
resource_type | string | Required | Resource type for the scheduling link. This is always 'EventType'. |
Requirements
Output
json— Response from the API endpoint 'create-scheduling-link'.CalendlyApi.CreateWebhookSubscription
Create a webhook subscription for events in Calendly. Use this tool to set up a webhook subscription for either an organization, user, or group. It triggers on specified events like invitee creation or cancellation. Useful for integrating Calendly events with other applications or systems.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
callback_url | string | Required | The endpoint URL to receive POST requests for subscribed events in Calendly. |
event_subscriptions | array<string> | Required | List of user events to subscribe to. Examples include 'invitee.created', 'invitee.canceled', etc. |
organization_reference | string | Required | The unique reference identifier for the organization associated with the webhook. |
webhook_subscription_scope | string | Required | Specifies the scope of the webhook subscription: "organization", "user", or "group". |
group_reference | string | Optional | The unique reference to the group that the webhook will be tied to. |
user_reference | string | Optional | The unique reference or ID of the user for whom the webhook will be tied. |
webhook_signing_key | string | Optional | Optional secret key shared between your application and Calendly for verifying webhook signatures. Useful for ensuring webhook messages' authenticity. |
Requirements
Output
json— Response from the API endpoint 'createwebhooks'.CalendlyApi.DeleteInviteeData
Request removal of invitee data from all booked events. Use this tool to submit a request for deleting an invitee's data from all previously booked events within your organization. It requires an Enterprise subscription and can take up to 7 days to complete.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invitee_email_list | array<string> | Required | A list of invitee emails to remove data for from all booked events. Each entry should be a valid email address. |
Requirements
Output
json— Response from the API endpoint 'delete-invitee-data'.CalendlyApi.DeleteScheduledEventsData
Delete scheduled events data within a past time range. Use this tool to request the deletion of scheduled events data for your organization within a specified past time range, up to 24 months. Completion may take up to 7 days. Requires an Enterprise subscription.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deletion_start_time_utc | string | Required | The UTC timestamp to start deleting scheduled events data. Must be in the past and not older than 24 months. |
end_time_utc | string | Required | The UTC timestamp marking the end of the time range for data deletion, in the past, no greater than 24 months ago. |
Requirements
Output
json— Response from the API endpoint 'delete-scheduled-event-data'.CalendlyApi.DeleteWebhookSubscription
Delete a webhook subscription on Calendly. Use this tool to delete a specific webhook subscription from Calendly by providing the webhook UUID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_uuid | string | Required | The unique identifier for the webhook subscription to be deleted. This is required to specify which subscription will be removed. |
Requirements
Output
json— Response from the API endpoint 'delete-webhook-subscription'.CalendlyApi.FetchEventTypeHosts
Fetches a list of event type hosts from Calendly. Use this tool to retrieve a list of hosts for event types on Calendly. This can be useful to determine availability or to manage event type assignments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_type_uri | string | Required | The URI associated with the event type to identify the hosts. |
number_of_rows_to_return | number | Optional | Specify the number of rows to fetch from the list of event type hosts. This determines the size of the dataset returned. |
pagination_token | string | Optional | Token for fetching the next or previous portion of the event type host list. |
Requirements
Output
json— Response from the API endpoint 'list-event-type-memberships'.CalendlyApi.FetchOutgoingCommunications
Retrieve outgoing SMS and email communications. Fetches a list of outgoing SMS and email communications for users with an Enterprise subscription.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_uri | string | Required | Return outgoing communications from the organization associated with this URI. This should be a valid URI string. |
created_before | string | Optional | Include outgoing communications created before this time in UTC format (e.g., "2020-01-02T03:04:05.678Z"). |
number_of_records_to_return | integer | Optional | The maximum number of outgoing communications records to retrieve. |
pagination_token | string | Optional | Token for fetching the next set of outgoing communications. |
start_time_utc | string | Optional | Include communications created after this UTC time (e.g. "2020-01-02T03:04:05.678Z"). |
Requirements
Output
json— Response from the API endpoint 'get-outgoing-communications'.CalendlyApi.GetCalendlyUserInfo
Retrieve user information from Calendly. Call this tool to get detailed information about a specific Calendly user using their UUID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_unique_identifier | string | Required | The unique identifier of the user. Use 'me' to reference the caller. |
Requirements
Output
json— Response from the API endpoint 'get-user'.CalendlyApi.GetEventAvailability
Retrieve availability for a specific event type. This tool returns the availability schedule for a given event type. It should be called when you need to check open time slots for booking or planning purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_type_uri | string | Required | The URI associated with the specific event type to retrieve availability. |
Requirements
Output
json— Response from the API endpoint 'get-event-type-availability'.CalendlyApi.GetEventDetails
Retrieve information about a specified scheduled event. Use this tool to get details about a specific event scheduled in Calendly, using the event's unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_unique_identifier | string | Required | The unique identifier for the event to retrieve details. |
Requirements
Output
json— Response from the API endpoint 'get-scheduled-event'.CalendlyApi.GetEventInviteeInfo
Fetch information about a specific event invitee. Use this tool to obtain detailed information about an invitee for a particular scheduled event on Calendly. Call this when you need specifics about a person invited to an event, identified by event and invitee UUIDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_unique_identifier | string | Required | The unique identifier for the specific Calendly event. Use this to specify which event's invitee details to retrieve. |
invitee_unique_identifier | string | Required | The unique identifier of the invitee for a specific event. |
Requirements
Output
json— Response from the API endpoint 'get-scheduled-event-invitees'.CalendlyApi.GetEventTypeInfo
Retrieve information about a specified event type on Calendly. Use this tool to obtain detailed information about a specific event type by providing its unique identifier (UUID). It's useful for understanding the configuration and settings of different event types in your Calendly account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_type_uuid | string | Required | The unique identifier (UUID) for the event type to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get-event-type'.CalendlyApi.GetGroupInfo
Retrieve information about a specified group in Calendly. Use this tool to get detailed information about a specific group in Calendly by providing the group's UUID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_unique_identifier | string | Required | A unique identifier for the group whose information is to be retrieved from Calendly. |
Requirements
Output
json— Response from the API endpoint 'get-group'.CalendlyApi.GetGroupList
Retrieve a list of groups from Calendly. Use this tool to obtain information about the various groups available in Calendly. It returns a list detailing these groups.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_uri | string | Required | URI for the organization to return associated groups from Calendly. |
number_of_rows | number | Optional | Specify the number of rows (groups) to return from the query. Used to limit results. |
pagination_token | string | Optional | Token for retrieving the next or previous set of groups in the list. |
Requirements
Output
json— Response from the API endpoint 'get-groups'.CalendlyApi.GetGroupRelationshipByUuid
Retrieve group relationship details using a UUID. This tool fetches the details of a group relationship in Calendly by using the unique identifier (UUID). Use it when you need to access specific group relationship information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_relationship_uuid | string | Required | The unique identifier (UUID) of the group relationship to retrieve details for. Use this to specify which relationship to fetch. |
Requirements
Output
json— Response from the API endpoint 'get-group-relationship'.CalendlyApi.GetInviteeNoShowDetails
Fetch details of a specified invitee no-show. Use this tool to retrieve detailed information about an invitee who did not show up for a scheduled event. This is helpful for managing scheduling follow-ups or analyzing attendance patterns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invitee_uuid | string | Required | The unique identifier for the invitee whose no-show information is being requested. |
Requirements
Output
json— Response from the API endpoint 'get-invitee-no-show'.CalendlyApi.GetOrganizationDetails
Retrieve details of a specified organization using UUID. Call this tool to obtain comprehensive information about an organization by providing its unique UUID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_uuid | string | Required | The unique identifier for the organization to retrieve details. |
Requirements
Output
json— Response from the API endpoint 'get-organization'.CalendlyApi.GetOrganizationInvitation
Fetches details of an organization's invitation. Use this tool to retrieve information about an invitation sent within an organization to its members. This can help track invitation status and details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_invitation_uuid | string | Required | The unique identifier of the organization's invitation. Provide this to retrieve specific invitation details. |
organization_unique_id | string | Required | The unique identifier for the organization. |
Requirements
Output
json— Response from the API endpoint 'get-organization-invitation'.CalendlyApi.GetOrganizationMembershipInfo
Retrieve details about a user's organization membership in Calendly. Use this tool to get information about a specific user's membership within an organization on Calendly. This tool can be called when you need detailed membership data for a given user, identified by their unique UUID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_membership_uuid | string | Required | The unique identifier for the organization's membership to retrieve details for a user. |
Requirements
Output
json— Response from the API endpoint 'get-organization-membership'.CalendlyApi.GetOrganizationMemberships
Retrieve organization memberships and related details. Use this tool to list the organization memberships for all users in an organization. You can also retrieve your organization's URI using this endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_email | string | Optional | A specific email address to filter the organization memberships by. Only memberships associated with this email will be returned. |
filter_by_organization | string | Optional | Filter the results by organization. Provide the organization's unique identifier or name to retrieve specific memberships. |
filter_by_role | string | Optional | Filter the results by role. Options: 'owner', 'admin', 'user'. |
filter_by_user | string | Optional | Filter the results by a specific user. Provide the user's identifier to narrow the search. |
next_page_token | string | Optional | Token used to retrieve the next or previous set of results for paginated data. |
number_of_rows_to_return | number | Optional | Specify the number of rows to return in the response. |
Requirements
Output
json— Response from the API endpoint 'list-organization-memberships'.CalendlyApi.GetRoutingForm
Retrieve details of a specified routing form. Call this tool to obtain information about a specific routing form using its UUID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
routing_form_uuid | string | Required | A unique identifier for the routing form to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get-routing-form'.CalendlyApi.GetRoutingFormSubmission
Retrieve a specified Routing Form Submission by UUID. This tool retrieves information about a specific routing form submission identified by its unique UUID. Use it to access details of a specific form submission in Calendly.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
submission_uuid | string | Required | Unique identifier for the routing form submission to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get-routing-form-submission'.CalendlyApi.GetSampleWebhookData
Retrieve sample webhook data for testing integrations. Use this tool to obtain a sample webhook payload from Calendly for testing your webhook subscription integration. This is useful for developers who want to ensure their systems can properly handle the data structure and content sent by Calendly webhooks before going live.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_identifier | string | Required | The unique identifier for the organization. It specifies which organization the sample webhook data belongs to. |
webhook_event_type | string | Required | Specify the type of webhook event to simulate, such as 'invitee.created' or 'invitee.canceled'. |
webhook_scope | string | Required | Specify the scope for the sample webhook data. Options are 'user', 'organization', or 'group'. |
user_identifier | string | Optional | The unique identifier for a user in Calendly whose webhook data you want to test. |
webhook_event_group | string | Optional | Specify the group for the webhook event to categorize and filter data. Typically used for organizing related webhooks. |
Requirements
Output
json— Response from the API endpoint 'get-sample-webhook-data'.CalendlyApi.GetUserAccountInfo
Retrieve basic information about the current Calendly user.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-current-user'.CalendlyApi.GetUserAvailabilitySchedule
Retrieve a user's availability schedule using their UUID. Use this tool to obtain the availability schedule for a specific user identified by their UUID. It provides the details of available time slots.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_uuid | string | Required | The UUID of the availability schedule you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-user-availability-schedule'.CalendlyApi.GetUserAvailabilitySchedules
Fetch a user's availability schedules. Use this tool to get the availability schedules of a specified user, assisting in planning or checking user availability.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_uri_reference | string | Required | A URI reference to the specified user whose availability schedules are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'list-user-availability-schedules'.CalendlyApi.GetUserLocationInfo
Retrieve configured location details for a specific user. This tool is used to obtain the location information that a user has configured in their account. It can be called when location details are needed for scheduling or meeting purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_uri | string | Required | The URI identifying the specific user to retrieve location information for. |
Requirements
Output
json— Response from the API endpoint 'list-user-locations'.CalendlyApi.GetWebhookSubscription
Retrieve details of a specific webhook subscription. Use this tool to get detailed information about a specific webhook subscription by providing its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_identifier | string | Required | The unique identifier of the webhook subscription to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-webhook-subscription'.CalendlyApi.InviteUserToOrganization
Invite a user to join an organization. This tool sends an invitation to a user to join a specific organization on Calendly. Use it when you need to add a new member to an organization by sending them an invitation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_unique_identifier | string | Required | The unique identifier for the organization to which the user is being invited. |
user_email | string | Required | The email address of the user to be invited to the organization. |
Requirements
Output
json— Response from the API endpoint 'create-organization-invitation'.CalendlyApi.ListActivityLogEntries
Fetch a list of activity log entries. This tool retrieves a list of activity log entries from Calendly, requiring an Enterprise subscription. It is useful for accessing detailed logs of various activities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_uri | string | Required | URI of the organization to filter activity log entries. |
actions | array<string> | Optional | Specify one or more actions associated with the log entries. Accepts an array of strings. |
entry_categories | array<string> | Optional | Specify the categories of log entries to filter the results. This is an array of strings, each representing a category. |
filter_by_search_term | string | Optional | Filters entries using supported operators: `|`, `+`, `"`, `-`, `()`, `*`. For example, `this | that` or `(email) + (signup)`. |
include_entries_after | string | Optional | Include entries that occurred after this time. Use format: "YYYY-MM-DDTHH:MM:SS.sssZ" (UTC). |
max_occurred_at_time | string | Optional | Include entries that occurred prior to this UTC time in the format "YYYY-MM-DDTHH:MM:SS.SSSZ". |
number_of_rows_to_return | integer | Optional | Specifies the number of activity log entries to return in the response. |
pagination_token | string | Optional | Token to get the next portion of the activity log collection. |
sort_order | array<string> | Optional | Specify the field and direction to sort results. Use format {field}:{direction}. |
user_associated_uris | array<string> | Optional | Return entries from the user(s) associated with the provided URIs. This should be an array of strings representing the URIs of users. |
Requirements
Output
json— Response from the API endpoint 'list-activity-log-entries'.CalendlyApi.ListAvailableEventTimes
Retrieve available times for an event type within a date range. Returns available times for a specified event type within a maximum 7-day date range. Useful for scheduling and planning events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
availability_end_time | string | Required | End time for the availability range, must be after the start time. |
availability_start_time | string | Required | The start time for the availability range. Must be a future date, not in the past. |
event_type_uri | string | Required | The URI associated with the event type to retrieve its available times. |
Requirements
Output
json— Response from the API endpoint 'list-event-type-available-times'.CalendlyApi.ListEventInvitees
Retrieve a list of invitees for a given event. Use this tool to obtain details about all invitees for a specific event. The tool is suitable when you need to see who has been invited to an event using its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_uuid | string | Required | The unique identifier for the event whose invitees are being retrieved. |
filter_by_email | string | Optional | Specify an email address to filter invitees by email. |
invitee_status | string | Optional | Filter invitees by their status: 'active' for current invitees or 'canceled' for those who have canceled. |
number_of_invitees_to_return | number | Optional | Specifies the number of invitee rows to return in the response. |
pagination_token | string | Optional | A token to retrieve the next or previous page of invitees. Useful for paginated responses. |
sort_order_by_created_at | string | Optional | Specify the order of results based on the creation date as 'asc' for ascending or 'desc' for descending. |
Requirements
Output
json— Response from the API endpoint 'list-event-invitees'.CalendlyApi.ListEventTypes
Fetches event types for a specified user or organization. This tool retrieves all event types associated with a specified user or organization in Calendly. Use it when you need to get a list of event types for scheduling or management purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
number_of_event_types_to_return | number | Optional | The number of event types to return. Specify the desired count of returned rows. |
only_admin_managed | boolean | Optional | Return only admin managed event types if true, exclude them if false, or include all if omitted. |
organization_uri | string | Optional | URI to view available personal, team, and organization event types. |
pagination_token | string | Optional | Token to retrieve the next or previous set of event types in pagination. |
return_active_event_types_only | boolean | Optional | Set to true to return only active event types, false for only inactive, or omit to include all event types. |
sort_event_types_by | string | Optional | Specify field and direction to order results. Use {field}:{asc/desc}. Fields: name, position, created_at, updated_at. |
user_availability_schedule_filter | string | Optional | Filters event types by the given primary availability schedule when used with the 'user' parameter. |
user_uri | string | Optional | The user's URI to view associated personal, team, and organization event types. |
Requirements
Output
json— Response from the API endpoint 'list-event-types'.CalendlyApi.ListGroupRelationships
Retrieve a list of group relationships for a given owner. Use this tool to get group relationship records, including one membership and multiple admin records for an owner.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_group | string | Optional | Filter results by a specific group using a group identifier. |
filter_by_organization | string | Optional | Filter results by organization. Provide the organization ID or URI to narrow down the list of group relationships. |
filter_by_owner_uri | string | Optional | The URI to filter results by owner, either an Organization Membership URI or Organization Invitation URI. |
number_of_rows | number | Optional | Specify the number of rows to return in the response. |
pagination_token | string | Optional | Token to navigate to the next or previous portion of the collection. |
Requirements
Output
json— Response from the API endpoint 'list-group-relationships'.CalendlyApi.ListOrganizationInvitations
Retrieve organization invitations sent to members. Use this tool to get a list of invitations that have been sent to members of a specific organization. This tool is useful for tracking pending or accepted invitations within the organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_unique_identifier | string | Required | The unique identifier for the organization to retrieve invitations for. |
filter_by_email | string | Optional | Email address to filter the results of organization invitations. |
filter_by_status | string | Optional | Filter results by invitation status: 'pending', 'accepted', or 'declined'. |
pagination_token | string | Optional | Token for fetching the next or previous set of organization invitations. |
rows_to_return | number | Optional | Specify the number of organization invitation records to retrieve in the request. |
sort_order | string | Optional | Specify the field and direction (ascending or descending) for sorting results. Use a comma-separated list for multiple criteria. |
Requirements
Output
json— Response from the API endpoint 'list-organization-invitations'.CalendlyApi.ListRoutingForms
Retrieve routing forms for a specified organization. Use this tool to obtain a list of all routing forms associated with a specific organization. It should be called when there is a need to access routing forms data for organizational purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_uri | string | Required | The URI of the organization to view its routing forms. It should be a valid string representing the organization's endpoint. |
number_of_rows | number | Optional | The number of routing form entries to return for the request. |
pagination_token | string | Optional | Token for fetching the next or previous portion of the routing forms collection. |
sort_order | string | Optional | Specify the order of results using field and direction. Supports 'created_at' with 'asc' or 'desc'. Use comma for multiple fields. |
Requirements
Output
json— Response from the API endpoint 'list-routing-forms'.CalendlyApi.ListRoutingFormSubmissions
Get a list of Routing Form Submissions for a specified form. Use this tool to retrieve submissions from a specific routing form in your Calendly account. Ideal for accessing user responses collected through these forms.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
routing_form_uri | string | Required | The URI of the routing form to view its submissions. This specifies which form's submissions to retrieve. |
number_of_rows_to_return | number | Optional | Specify the number of routing form submissions to return. |
pagination_token | string | Optional | Token for retrieving the next or previous set of form submissions. |
sort_order | string | Optional | Specify field and direction to sort results (e.g., 'created_at:asc'). |
Requirements
Output
json— Response from the API endpoint 'list-routing-form-submissions'.CalendlyApi.ListScheduledEvents
Retrieve a list of scheduled events from Calendly. Use this tool to get scheduled events based on specific criteria. Pass the 'organization' parameter to fetch events for an organization, 'user' for personal or specific user events, and 'group' for group events. Admins or owners have additional privileges for broader queries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_status | string | Optional | Indicate if the event is 'active' or 'canceled'. |
events_sort_order | string | Optional | Specify sorting order for events. Use 'start_time:asc' or 'start_time:desc'. |
group_uri | string | Optional | URI of the group to fetch scheduled events for. Requires admin/owner or group admin privilege. |
invitee_email | string | Optional | Email address of the invitee to filter and return related scheduled events. |
max_start_time_utc | string | Optional | Include events with start times prior to this UTC time. Format: YYYY-MM-DDTHH:MM:SS.ssssssZ |
min_start_time | string | Optional | Include events starting after this UTC time. Format: "2020-01-02T03:04:05.678123Z". |
number_of_rows_to_return | number | Optional | Specify the number of event entries to retrieve. |
organization_uri | string | Optional | URI of the organization to retrieve scheduled events for. Requires admin/owner privileges. |
pagination_token | string | Optional | Token for navigating to the next or previous set of scheduled events. |
user_uri | string | Optional | URI identifying the user for whom to return scheduled events. Use alone for personal events or with 'organization' for specific user events within an organization. |
Requirements
Output
json— Response from the API endpoint 'list-scheduled-events'.CalendlyApi.ListUserBusyTimes
Retrieve user's scheduled events within a specific date range. Use this tool to obtain an ascending list of all internal and external events scheduled for a user within a specified date range, up to 7 days. External events are returned only if calendars are set to "Check for conflicts." This tool is helpful for checking availability or scheduling new events based on the user's current commitments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
availability_start_time | string | Required | Start time for the availability range. The date must not be in the past. |
end_time | string | Required | End time for the requested availability range, must be after the start_time. |
user_uri | string | Required | The URI associated with the user to retrieve busy times for. |
Requirements
Output
json— Response from the API endpoint 'list-user-busy-times'.CalendlyApi.ListWebhookSubscriptions
Retrieve webhook subscriptions for an organization or user. Use this tool to obtain a list of webhook subscriptions associated with a specified organization or user on Calendly.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_scope | string | Required | Filter the list by organization, user, or group. Acceptable values are 'organization', 'user', or 'group'. |
organization_id | string | Required | The ID of the organization that owns the subscriptions being returned. This field is always required. |
filter_by_group | string | Optional | Optional; filters the results by group when scope is set to 'group'. |
filter_by_user | string | Optional | Filter results by user when 'scope' is set to 'user'. |
number_of_rows_to_return | number | Optional | Specify the number of rows to be returned in the result set. |
pagination_token | string | Optional | The token to retrieve the next or previous portion of the collection. |
sort_by_field_and_direction | string | Optional | Specify the field and direction to order results. Use 'created_at:asc' or 'created_at:desc'. |
Requirements
Output
json— Response from the API endpoint 'list-webhook-subscriptions'.CalendlyApi.MarkInviteeNoShow
Mark an invitee as a no show in Calendly. Use this tool to mark an invitee as a no show in Calendly. It should be called when you need to record that an invitee did not attend a scheduled event.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invitee_id | string | Optional | The unique identifier for the invitee to be marked as a no show. This is required to specify which invitee did not attend. |
Requirements
Output
json— Response from the API endpoint 'create-invitee-no-show'.CalendlyApi.RemoveUserFromOrganization
Remove a user from an organization with admin rights. This tool removes a user from an organization in Calendly. It requires the caller to have admin rights and cannot be used to remove an organization owner.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_membership_unique_id | string | Required | The unique identifier for the organization membership to be removed. |
Requirements
Output
json— Response from the API endpoint 'delete-organization-membership'.CalendlyApi.RevokeOrganizationInvitation
Revoke an organization invitation in Calendly. Use this tool to revoke an organization invitation in Calendly, rendering the invitation link invalid.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invitation_unique_identifier | string | Required | The unique identifier for the organization invitation to be revoked. |
organization_unique_identifier | string | Required | The organization's unique identifier required to revoke the invitation. |
Requirements
Output
json— Response from the API endpoint 'revoke-organization-invitation'.CalendlyApi.UndoInviteeNoShowStatus
Undo the no-show status for a Calendly invitee. This tool removes the no-show status previously assigned to an invitee in Calendly. Use it to correct any erroneous no-show markings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invitee_unique_id | string | Required | The unique identifier for the invitee whose no-show status is to be undone. |
Requirements
Output
json— Response from the API endpoint 'delete-invitee-no-show'.CalendlyApi.UpdateEventAvailability
Update an event type availability schedule. Use this tool to modify the availability schedule of an existing calendar event type, such as updating times or days available. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_type_uri | string | Optional | URI of the event type to update the availability schedule for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-event-type-availability'.CalendlyApi.UpdateEventType
Update details of an existing event type with Calendly. Use this tool to update an existing one-on-one event type in Calendly. This tool is specifically for modifying event types categorized as 'solo' or one-on-one. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
event_type_uuid | string | Optional | The unique identifier for the event type to be updated. This is essential for specifying which one-on-one event type you intend to modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-event-type'.