Calendly

calendly

Calendly is an appointment scheduling tool that automates meeting invitations, availability checks, and reminders, helping individuals and teams avoid email back-and-forth

Scheduling & Booking Calendar Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (42)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Cancel eventCALENDLY_CANCEL_EVENTAcción

Permanently cancels an existing, active scheduled event by its `uuid`, optionally providing a `reason`, which may trigger notifications to invitees.

Parámetros de entrada

uuidstringObligatorio
Unique identifier (UUID) of the event to be canceled.
reasonstring
Reason for canceling the event; may be included in the cancellation notification to the invitee.

Parámetros de salida

dataobjectObligatorio
Details of the cancellation confirmation; typically indicates success and may include specifics of the canceled event.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an invitee no-showCALENDLY_CREATE_INVITEE_NO_SHOWAcción

Marks an invitee, identified by their existing and valid uri, as a 'no show' for a scheduled event.

Parámetros de entrada

inviteestringuri
URI of the Invitee to be marked as a no-show.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the invitee no-show object that was created. It includes details such as the no-show URI, the original invitee URI, and timestamps.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create One-Off Event TypeCALENDLY_CREATE_ONE_OFF_EVENT_TYPEAcción

Creates a temporary calendly one-off event type for unique meetings outside regular availability, requiring valid host/co-host uris, a future date/range for `date setting`, and a positive `duration`.

Parámetros de entrada

hoststringObligatorio
The URI of the user who will be the host of the one-off event
namestringObligatorio
Name of the one-off event type
durationintegerObligatorio
Duration of the event in minutes
locationobject
Location configuration for the event.
timezonestring
IANA timezone identifier for the event scheduling. Determines how times are interpreted and displayed to invitees.
date_settingobjectObligatorio
Date range setting for events available within a specific date range.
only_weekdaysboolean
Excludes weekends and only counts Monday - Friday (required for days_in_future date_setting type)

Parámetros de salida

dataobjectObligatorio
One-off event type resource containing the created event type details
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create scheduling linkCALENDLY_CREATE_SCHEDULING_LINKAcción

Create a single-use scheduling link. creates a scheduling link that can be used to book an event. the link allows invitees to schedule up to the specified maximum number of events. once the limit is reached, the link becomes inactive.

Parámetros de entrada

ownerstringObligatorio
Event type URI (e.g., 'https://api.calendly.com/event_types/...')
owner_typestring
Type of owner, typically 'EventType'
max_event_countintegerObligatorio
The max number of events that can be scheduled using this scheduling link

Parámetros de salida

dataobjectObligatorio
Scheduling link resource containing the generated booking link
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create shareCALENDLY_CREATE_SHAREAcción

Creates a customizable, one-time share link for a calendly event type, allowing specific overrides to its settings (e.g., duration, availability, location) without altering the original event type.

Parámetros de entrada

namestring
Custom name for the shared link; defaults to event type name if unspecified.
durationinteger
Custom event duration in minutes, overriding event type default.
end_datestringdate
End date (YYYY-MM-DD) for shared link availability; required if `period_type` is 'fixed'.
event_typestringObligatoriouri
URI of the event type to base this share on.
start_datestringdate
Start date (YYYY-MM-DD) for shared link availability; required if `period_type` is 'fixed'.
period_typestringenum
Availability period type: 'available_moving' (shows actual available slots for `max_booking_time` days), 'moving' (available for `max_booking_time` days), 'fixed' (within `start_date`/`end_date`), 'unlimited'.
available_movingmovingfixedunlimited
hide_locationboolean
If true, hides event location until booking (only if event type has a single custom location).
duration_optionsinteger[]
Alternative selectable durations in minutes, overriding event type options.
max_booking_timeinteger
Max days in advance an invitee can book; required if `period_type` is 'moving' or 'available_moving'.
location_configurationsobject[]
Custom location settings that override the event type's default locations. Each configuration specifies a location type and associated details.
availability__rule__rulesobject[]
List of custom availability rules that override the event type's default schedule. Provide an array of objects EACH containing: `type`=`'wday'`, `wday` (weekday), and `intervals` (list of `{from, to}` times). Field names are case-sensitive – use **`wday`, `from`, `to`** exactly. Must be combined with `availability_rule_timezone`.
availability__rule__timezonestring
IANA timezone (e.g., 'America/New_York') for custom availability rules. Required with `availability_rule_rules`.

Parámetros de salida

dataobjectObligatorio
Details of the created share, including its URI and configuration.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create single use scheduling linkCALENDLY_CREATE_SINGLE_USE_SCHEDULING_LINKAcción

Creates a one-time, single-use scheduling link for an active calendly event type, expiring after one booking.

Parámetros de entrada

ownerstringObligatoriouri
The URI of the Calendly Event Type that will own this single-use scheduling link. This Event Type's settings (e.g., duration, availability) will apply to the scheduled meeting.
owner_typestringObligatorioenum
Identifies the owner resource type, which is 'EventType'.
EventType
max_event_countintegerObligatorio
The maximum number of events that can be scheduled using this link. For a single-use link, this value must be 1.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the resource representation of the newly created single-use scheduling link. This typically includes `booking_url` (the URL to be shared with the invitee), `owner`, `owner_type`, `status`, and the `uri` of the scheduling link itself.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create webhook subscriptionCALENDLY_CREATE_WEBHOOK_SUBSCRIPTIONAcción

Creates a calendly webhook subscription to notify a specified `url` (which must be a publicly accessible https endpoint) for selected `events` within a given `organization` and `scope`.

Parámetros de entrada

urlstringObligatoriouri
Publicly accessible and active callback URL to receive POST requests for subscribed events.
userstringuri
URI of the user for the webhook; required if 'scope' is 'user'.
groupstringuri
URI of the group for the webhook; required if 'scope' is 'group'.
scopestringObligatorioenum
Scope of the webhook: 'organization', 'user', or 'group'.
organizationusergroup
eventsstring[]Obligatorio
Event types to subscribe to.
signing_keystring
Optional secret key (6-24 characters) for signing webhook events to verify their authenticity.
organizationstringObligatoriouri
URI of the organization for the webhook.

Parámetros de salida

dataobjectObligatorio
Details of the created webhook subscription resource, including its URI, callback URL, subscribed events, scope, state, and timestamps.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete invitee dataCALENDLY_DELETE_INVITEE_DATAAcción

Permanently removes all invitee data associated with the provided emails from past organization events, for data privacy compliance (requires enterprise subscription; deletion may take up to one week).

Parámetros de entrada

emailsstring[]Obligatorio
Invitee email addresses for whom all associated data will be permanently removed.

Parámetros de salida

dataobjectObligatorio
API response, potentially including confirmation or status of the data deletion request.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete invitee no showCALENDLY_DELETE_INVITEE_NO_SHOWAcción

Deletes an invitee no-show record by its `uuid` to reverse an invitee's 'no-show' status; the `uuid` must refer to an existing record.

Parámetros de entrada

uuidstringObligatorio
The unique identifier (UUID) of the Invitee No-Show record to be removed.

Parámetros de salida

dataobjectObligatorio
Typically empty upon successful deletion, as the API returns a 204 No Content status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete scheduled event dataCALENDLY_DELETE_SCHEDULED_EVENT_DATAAcción

For enterprise users, initiates deletion of an organization's scheduled event data between a `start time` and `end time` (inclusive, where `start time` must be <= `end time`); actual data deletion may take up to 7 days to complete.

Parámetros de entrada

end_timestringObligatoriodate-time
Defines the end of the data deletion period (UTC). Events ending at or before this time will be included. Must be within the past 24 months.
start_timestringObligatoriodate-time
Defines the start of the data deletion period (UTC). Events starting at or after this time will be included. Must be within the past 24 months.

Parámetros de salida

dataobjectObligatorio
API response, typically an empty dictionary or a confirmation message on successful initiation of the data deletion request.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete webhook subscriptionCALENDLY_DELETE_WEBHOOK_SUBSCRIPTIONAcción

Deletes an existing webhook subscription to stop calendly sending event notifications to its registered callback url; this operation is idempotent.

Parámetros de entrada

webhook_uuidstringObligatorio
The unique identifier (UUID) of the webhook subscription to be deleted.

Parámetros de salida

dataobject
A dictionary containing the response data. For a successful deletion (HTTP 204 No Content), this field is typically empty. In case of errors, it may contain error details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get current userCALENDLY_GET_CURRENT_USERAcción

Retrieves detailed information about the currently authenticated calendly user.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
User resource containing user information like URI, name, email, scheduling URL, timezone, and organization
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get eventCALENDLY_GET_EVENTAcción

Use to retrieve a specific calendly scheduled event by its uuid, provided the event exists in the user's calendly account.

Parámetros de entrada

uuidstringObligatorio
Unique identifier (UUID) of the Calendly event.

Parámetros de salida

dataobjectObligatorio
Full details of the specified Calendly event.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get event inviteeCALENDLY_GET_EVENT_INVITEEAcción

Retrieves detailed information about a specific invitee of a scheduled event, using their unique uuids.

Parámetros de entrada

event_uuidstringObligatorio
The unique identifier (UUID) of the scheduled event.
invitee_uuidstringObligatorio
The unique identifier (UUID) of the invitee for the specified event.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the invitee resource object. The resource object includes full details of the invitee such as `uri`, `email`, `name`, `status` (e.g., 'active', 'canceled'), `questions_and_answers`, `timezone`, `event_uri`, `cancel_url`, `reschedule_url`, `created_at`, `updated_at`, `payment`, `no_show`, and `reconfirmation`.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get event typeCALENDLY_GET_EVENT_TYPEAcción

Retrieves details for a specific calendly event type, identified by its uuid, which must be valid and correspond to an existing event type.

Parámetros de entrada

uuidstringObligatorio
Unique identifier (UUID) for the event type.

Parámetros de salida

dataobjectObligatorio
Event type resource, including all its attributes and configuration details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get groupCALENDLY_GET_GROUPAcción

Retrieves all attributes of a specific calendly group by its uuid; the group must exist.

Parámetros de entrada

uuidstringObligatorio
Unique identifier (UUID) of the Calendly group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get group relationshipCALENDLY_GET_GROUP_RELATIONSHIPAcción

Retrieves a specific calendly group relationship by its valid and existing uuid, providing details on user-group associations and membership.

Parámetros de entrada

uuidstringObligatorio
The unique identifier (UUID) of the group relationship to be retrieved.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get invitee no showCALENDLY_GET_INVITEE_NO_SHOWAcción

Retrieves details for a specific invitee no show record by its uuid; an invitee no show is marked when an invitee does not attend a scheduled event.

Parámetros de entrada

uuidstringObligatorio
The unique identifier (UUID) of the Invitee No Show record to retrieve.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the Invitee No Show object. This object includes details such as when the no-show was recorded and the associated invitee.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get organization invitationCALENDLY_GET_ORGANIZATION_INVITATIONAcción

Retrieves a specific calendly organization invitation using its uuid and the parent organization's uuid.

Parámetros de entrada

uuidstringObligatorio
The unique identifier (UUID) of the specific organization invitation to retrieve.
org_uuidstringObligatorio
The unique identifier (UUID) of the Calendly organization to which the invitation belongs.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get organization membershipCALENDLY_GET_ORGANIZATION_MEMBERSHIPAcción

Retrieves a specific calendly organization membership by its uuid, returning all its attributes.

Parámetros de entrada

uuidstringObligatorio
The unique identifier (UUID) of the organization membership to retrieve.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get routing formCALENDLY_GET_ROUTING_FORMAcción

Retrieves a specific routing form by its uuid, providing its configuration details including questions and routing logic.

Parámetros de entrada

uuidstringObligatorio
The unique identifier (UUID) of the routing form to retrieve.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the routing form object, containing its attributes and configuration.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get userCALENDLY_GET_USERAcción

Retrieves comprehensive details for an existing calendly user.

Parámetros de entrada

uuidstringObligatorio
The unique identifier (UUID) of the user. Alternatively, use the literal string "me" to refer to the currently authenticated user (the caller).

Parámetros de salida

dataobjectObligatorio
A dictionary object containing the detailed information for the retrieved user. Key fields typically include: `uri` (the user's unique canonical URI), `name` (full name), `email`, `avatar_url` (URL of the user's avatar image), `scheduling_url` (the user's main scheduling page URL), `timezone` (e.g., 'America/New_York'), `created_at` (ISO 8601 timestamp of user creation), `updated_at` (ISO 8601 timestamp of last update), and `organization_uri` (URI of the organization the user belongs to). Note: The exact set of fields returned may vary.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get user availability scheduleCALENDLY_GET_USER_AVAILABILITY_SCHEDULEAcción

Retrieves an existing user availability schedule by its uuid; this schedule defines the user's default hours of availability.

Parámetros de entrada

uuidstringObligatorio
Unique identifier (UUID) of the availability schedule.

Parámetros de salida

dataobjectObligatorio
The availability schedule resource, including user URI, schedule name, timezone, default status, and rules for available time slots.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get webhook subscriptionCALENDLY_GET_WEBHOOK_SUBSCRIPTIONAcción

Retrieves the details of an existing webhook subscription, identified by its uuid, including its callback url, subscribed events, scope, and state.

Parámetros de entrada

webhook_uuidstringObligatorio
Unique identifier (UUID) of the webhook subscription to retrieve.

Parámetros de salida

dataobjectObligatorio
Webhook subscription resource. Includes `uri`, `callback_url`, `created_at`, `updated_at`, `state` (active or disabled), `events` (list of subscribed event types), `scope` (organization or user), `organization` URI, `user` URI, and `creator` URI.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Invite user to organizationCALENDLY_INVITE_USER_TO_ORGANIZATIONAcción

Invites a user to the specified calendly organization by email, if they aren't already a member and lack a pending invitation to it.

Parámetros de entrada

uuidstringObligatorio
Unique identifier (UUID) of the organization to which the user will be invited.
emailstringObligatorioemail
The email address of the user to be invited to the organization. An invitation link will be sent to this email.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the details of the successfully created organization invitation. This includes fields like the invitation's URI, organization URI, user's email, status (e.g., 'pending'), and relevant timestamps (created_at, updated_at).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List activity log entriesCALENDLY_LIST_ACTIVITY_LOG_ENTRIESAcción

Retrieves a list of activity log entries for a specified calendly organization (requires an active enterprise subscription), supporting filtering, sorting, and pagination.

Parámetros de entrada

sortstring[]
Specifies the sort order for the results. Provide a list of sort criteria strings, each in the format 'field:direction' (e.g., 'occurred_at:asc'). Valid fields and directions are defined by SortEnm.
actorstring[]
Filters activity log entries by the users who performed the actions. Provide a list of user URIs.
countinteger
The maximum number of activity log entries to return per page.
actionstring[]
Filters entries by the specific action performed (e.g., 'user.created', 'event_type.updated'). Provide a list of action strings.
namespacestring[]
Filters entries by their category or domain (namespace). Provide a list of namespace strings. Common examples include 'user_management' or 'event_type_management'.
page_tokenstring
Token for pagination, used to fetch the next page of results if the collection spans multiple pages.
search_termstring
Filters entries based on the search term. Supported operators: `|` (OR, e.g., `user.created | group.created`), `+` (AND, e.g., `user.created + user.invited`), `" "` (exact phrase, e.g., `"John Doe"`), `-` (exclude term, e.g., `user.created -admin`), `()` (precedence, e.g., `(user.created | user.invited) + team1`), and `*` (prefix search, e.g., `user.email_address:*@example.com`).
organizationstringObligatorio
URI of the Calendly organization for which to retrieve activity log entries.
max_occurred_atstring
Timestamp in ISO 8601 UTC format (e.g., '2020-01-02T03:04:05.678Z'). Filters entries to include only those that occurred at or before this time.
min_occurred_atstring
Timestamp in ISO 8601 UTC format (e.g., '2020-01-02T03:04:05.678Z'). Filters entries to include only those that occurred at or after this time.

Parámetros de salida

dataobjectObligatorio
The API response, typically a dictionary containing a 'collection' of activity log entries and 'pagination' details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List event inviteesCALENDLY_LIST_EVENT_INVITEESAcción

Retrieves a list of invitees for a specified calendly event uuid, with options to filter by status or email, and sort by creation time.

Parámetros de entrada

sortstring
Order results by the `created_at` field; use 'created_at:asc' for ascending or 'created_at:desc' for descending.
uuidstringObligatorio
The unique identifier (UUID) of the event for which to list invitees.
countinteger
The number of invitees to return per page. Default is 20.
emailstring
Filter results by a specific invitee's email address.
statusstringenum
Filter invitees by their status. Can be 'active' or 'canceled'.
activecanceled
page_tokenstring
A token to retrieve the next or previous page of results in a paginated collection.

Parámetros de salida

dataobjectObligatorio
The response payload, typically containing a 'collection' of invitee objects and 'pagination' information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List eventsCALENDLY_LIST_EVENTSAcción

Retrieves a list of scheduled calendly events; requires `user`, `organization`, `group`, or `invitee email` for scope, and admin rights may be needed when filtering by `organization` or `group`.

Parámetros de entrada

sortstring
Sort order for the results. Accepts comma-separated `field:direction` values. Supported field: `start_time`. Supported directions: `asc` (ascending), `desc` (descending).
userstring
URI of the **user** whose events you want to list. Exactly ONE of `user`, `organization`, or `group` must be supplied to scope the query.
countinteger
The number of events to return per page.
groupstring
URI of the **group** (team) whose events you want to list. Exactly ONE of `user`, `organization`, or `group` must be provided.
statusstringenum
Filter events by their status.
activecanceled
page_tokenstring
Token for pagination to retrieve the next or previous set of results from the collection.
organizationstring
URI of the **organization** whose events you want to list. Exactly ONE of `user`, `organization`, or `group` is required. Admin privileges may be required.
invitee_emailstring
Invitee's email address to filter events by.
max_start_timestring
Include events with start times at or before this UTC timestamp (e.g., '2020-01-02T03:04:05.678123Z').
min_start_timestring
Include events with start times at or after this UTC timestamp (e.g., '2020-01-02T03:04:05.678123Z').

Parámetros de salida

dataobjectObligatorio
The response payload containing a 'collection' of event objects and 'pagination' details. Each event object typically includes details like event URI, name, start/end times, and status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List event type available timesCALENDLY_LIST_EVENT_TYPE_AVAILABLE_TIMESAcción

Fetches available time slots for a calendly event type within a specified time range; results are not paginated.

Parámetros de entrada

end_timestringObligatorio
End datetime (exclusive) of the requested availability range, in UTC ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ'). The duration between start_time and end_time cannot exceed 7 days.
event_typestringObligatorio
The URI of the event type for which to find available times. This can be obtained by listing event types or from an event type object.
start_timestringObligatorio
Start datetime (inclusive) of the requested availability range, in UTC ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ').

Parámetros de salida

dataobjectObligatorio
A dictionary containing the raw response data from the Calendly API. This typically includes a 'collection' key, which is a list of available time slot objects. Each object details an available slot, including its start time and scheduling URL.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List event type hostsCALENDLY_LIST_EVENT_TYPE_HOSTSAcción

Retrieves a list of hosts (users) assigned to a specific, existing calendly event type, identified by its uri.

Parámetros de entrada

countinteger
Number of event type hosts to return per page.
event_typestringObligatorio
URI of an existing event type for which to list hosts.
page_tokenstring
Token from a previous list call to get the next/previous page of results.

Parámetros de salida

dataobjectObligatorio
Contains the collection of event type hosts (users) and pagination details. Each host object details the assigned user.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List group relationshipsCALENDLY_LIST_GROUP_RELATIONSHIPSAcción

Retrieves a list of group relationships defining an owner's role (e.g., member, admin) within a group; an owner can have one membership per group but multiple admin roles across different groups.

Parámetros de entrada

countinteger
Number of records per page (max 100).
groupstring
Filter results by group URI.
ownerstring
Filter results by owner URI (Organization Membership or Invitation URI).
page_tokenstring
Token for retrieving a specific page of results, obtained from `next_page_token` or `previous_page_token` in a previous response.
organizationstring
Filter results by organization URI.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List groupsCALENDLY_LIST_GROUPSAcción

Returns a list of groups for a specified calendly organization uri, supporting pagination.

Parámetros de entrada

countinteger
The maximum number of groups to return per page. The value can range from 1 to 100.
page_tokenstring
A token to retrieve a specific page of results. Pass this value from a previous response's 'next_page_token' to fetch the next set of groups, or 'previous_page_token' for the previous set.
organizationstringObligatorio
The URI of the organization to filter groups by. For example, 'https://api.calendly.com/organizations/ORGANIZATION_UUID'.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization invitationsCALENDLY_LIST_ORGANIZATION_INVITATIONSAcción

Retrieves a list of invitations for a specific organization, identified by its uuid.

Parámetros de entrada

sortstring
Order of results by field(s) and direction (asc/desc); e.g., 'created_at:asc' or 'email:desc,status:asc'.
uuidstringObligatorio
Unique identifier (UUID) of the organization.
countinteger
Number of results to return per page.
emailstring
Filter by the recipient's email address.
statusstringenum
Filter by invitation status.
pendingaccepteddeclined
page_tokenstring
Pagination token to access a specific page of results.

Parámetros de salida

dataobjectObligatorio
Dictionary with the 'collection' of organization invitations and 'pagination' information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization membershipsCALENDLY_LIST_ORGANIZATION_MEMBERSHIPSAcción

Retrieves a list of organization memberships.

Parámetros de entrada

userstring
Filter memberships by the URI of the user. For example, 'https://api.calendly.com/users/USER_UUID'.
countinteger
The number of membership records to return per page. Must be an integer between 1 and 100, inclusive.
emailstring
Filter memberships by the email address of the user. For example, 'user@example.com'.
page_tokenstring
The token to retrieve the next or previous page of results in a paginated collection.
organizationstring
Filter memberships by the URI of the organization. For example, 'https://api.calendly.com/organizations/ORGANIZATION_UUID'.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the list of organization memberships and pagination details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List outgoing communicationsCALENDLY_LIST_OUTGOING_COMMUNICATIONSAcción

Retrieves a list of outgoing sms communications for a specified organization; requires an enterprise subscription and if filtering by creation date, both `min created at` and `max created at` must be provided to form a valid range.

Parámetros de entrada

countinteger
The number of records to return per page. Must be between 1 and 100, inclusive.
page_tokenstring
The token to retrieve the next page of results. Provided in the `next_page_token` field of a previous response.
organizationstringObligatorio
The URI of the organization whose outgoing communications are to be retrieved.
max_created_atstring
Include outgoing communications that were created before this timestamp. Formatted as "YYYY-MM-DDTHH:MM:SS.sssZ" in UTC.
min_created_atstring
Include outgoing communications that were created after this timestamp. Formatted as "YYYY-MM-DDTHH:MM:SS.sssZ" in UTC.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List routing formsCALENDLY_LIST_ROUTING_FORMSAcción

Retrieves routing forms for a specified organization; routing forms are questionnaires used to direct invitees to appropriate booking pages or external urls.

Parámetros de entrada

sortstring
Specifies the order of results. Use a comma-separated list of `field:direction` pairs. Supported field: `created_at`. Supported directions: `asc` (ascending), `desc` (descending).
countinteger
The number of routing forms to return per page.
page_tokenstring
Token to retrieve a specific page of results, usually from a previous response's pagination details.
organizationstringObligatorio
The URI of the organization for which to retrieve routing forms.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the list of routing forms under the 'collection' key and pagination details under the 'pagination' key. Each routing form object includes details such as its URI, name, status, questions, and owner information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List user availability schedulesCALENDLY_LIST_USER_AVAILABILITY_SCHEDULESAcción

Retrieves all availability schedules for the specified calendly user.

Parámetros de entrada

userstringObligatorio
URI of the user whose availability schedules are to be listed; must be a valid Calendly user URI.

Parámetros de salida

dataobjectObligatorio
A dictionary mapping schedule identifiers to the user's detailed availability schedule objects.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List user busy timesCALENDLY_LIST_USER_BUSY_TIMESAcción

Fetches a user's busy time intervals (internal and external calendar events) in ascending order for a period up to 7 days; keyset pagination is not supported.

Parámetros de entrada

userstringObligatorio
The URI of the user whose busy times are being queried. This is typically the user's Calendly API URI.
end_timestringObligatorio
The end of the time range for which to fetch busy times, in RFC3339 format (e.g., '2023-10-26T11:00:00Z'). Must be after start_time.
start_timestringObligatorio
The start of the time range for which to fetch busy times, in RFC3339 format (e.g., '2023-10-26T10:00:00Z').

Parámetros de salida

dataobjectObligatorio
A dictionary containing the raw response data from the Calendly API. This typically includes a 'collection' field, which is a list of objects detailing the user's busy time intervals (e.g., start time, end time, type of event).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List user event typesCALENDLY_LIST_USER_S_EVENT_TYPESAcción

Retrieves event types for a user or organization; requires either the `user` or `organization` uri.

Parámetros de entrada

sortstring
Order results by field(s) and direction ('asc' or 'desc'), e.g., 'name:asc,created_at:desc'. Supported fields: name, position, created_at, updated_at.
userstring
URI of the **user** whose event types to list. Provide **either** `user` **or** `organization` (exactly one is required).
countinteger
Number of event types per page (max 100).
activeboolean
Filter by active status (true for active, false for inactive). If omitted, all event types are returned.
page_tokenstring
Token for retrieving the next or previous page of event types.
organizationstring
URI of the **organization** whose event types to list. Provide **either** `organization` **or** `user` (exactly one is required).
admin_managedboolean
Filter by admin management: true for admin-managed only, false to exclude admin-managed. If omitted, all types are returned (respecting other filters).
user_availability_schedulestring
URI of the user's availability schedule; use with `user` to filter event types by this primary schedule. Example: 'https://api.calendly.com/user_availability_schedules/SCHEDULE_UUID'.

Parámetros de salida

dataobjectObligatorio
API response dictionary, typically including 'collection' (list of event types) and 'pagination' details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List webhook subscriptionsCALENDLY_LIST_WEBHOOK_SUBSCRIPTIONSAcción

Retrieves webhook subscriptions for a calendly organization; `scope` determines if `user` or `group` uri is also required for filtering.

Parámetros de entrada

sortstring
Sort order for results (e.g., 'created_at:asc'). Supported fields: `created_at`, `updated_at`. Supported directions: `asc`, `desc`.
userstring
URI of the Calendly user; required if `scope` is 'user'.
countinteger
Number of results per page (maximum 100).
groupstring
URI of the Calendly group; required if `scope` is 'group'.
scopestringObligatorioenum
Scope of the webhook subscriptions: 'organization', 'user', or 'group'.
organizationusergroup
page_tokenstring
Token for paginating to the next or previous page of results.
organizationstringObligatorio
URI of the Calendly organization for which to list webhook subscriptions.

Parámetros de salida

dataobjectObligatorio
Collection of webhook subscriptions matching the request criteria.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove user from organizationCALENDLY_REMOVE_USER_FROM_ORGANIZATIONAcción

Removes a user (who is not an owner) from an organization by their membership uuid, requiring administrative privileges.

Parámetros de entrada

uuidstringObligatorio
The unique identifier of the organization membership to be removed.

Parámetros de salida

dataobjectObligatorio
A dictionary containing data related to the outcome of the operation; may be empty for successful deletions.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Revoke a user's organization invitationCALENDLY_REVOKE_USER_S_ORGANIZATION_INVITATIONAcción

Revokes a pending and revokable (not yet accepted or expired) organization invitation using its uuid and the organization's uuid, rendering the invitation link invalid.

Parámetros de entrada

uuidstringObligatorio
The unique identifier of the organization invitation to be revoked.
org_uuidstringObligatorio
The unique identifier of the organization.

Parámetros de salida

dataobject
An empty dictionary, as a successful revocation typically returns a 204 No Content response.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not