Skip to main content
Scheduleonce logo
  • Category: scheduling & booking
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 27
  • Triggers: 0
  • Slug: SCHEDULEONCE
  • Version: 20261101_00

Tools

Slug: SCHEDULEONCE_BOOK_TIME_SLOTTool to book a time slot on a booking calendar in OnceHub. Use when you need to schedule a meeting by booking one of the available time slots. First retrieve available time slots using ‘Get available time slots’, then use this tool to book one of those slots with guest information.

Input Parameters

string
required
The unique identifier of the booking calendar to book a time slot for (e.g., ‘BKC-ZK6W94KE6W’)
string
required
The date and time of the time slot to book in ISO 8601 format. Must be in UTC timezone (e.g., ‘2025-12-22T04:30:00.000Z’). Use this with a time slot retrieved from the ‘Get available time slots’ endpoint.
object
required
Form data containing guest information including name, email, and optional fields
array
Array of custom field objects with ‘name’ and ‘value’ properties
string
Type of location for the meeting. Can only select from locations offered within the available time slots.
string
Location-specific value. For virtual meetings: conference type (e.g., ‘google_meet’, ‘zoom’). For phone: guest’s phone number. For physical locations: address ID (e.g., ‘ADD-1234’).
string
required
The guest’s timezone in IANA format (e.g., ‘America/New_York’, ‘Europe/London’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_CANCEL_BOOKINGCancel a OnceHub booking by ID, optionally providing a reason and controlling cancellation emails. Paid bookings cannot be canceled through this endpoint.

Input Parameters

string
required
The unique identifier of the booking to cancel (e.g., ‘BKNG-J4FR05BKEWEX’)
string
The reason for canceling the booking. This will be stored in the cancel_reschedule_information.reason field of the booking object.
boolean
Determines whether a cancellation email notification should be sent to the customer and other participants.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_CREATE_CONTACTTool to create a new contact in ScheduleOnce. Use when you need to add a contact with email, first name, and last name. Additional fields like company, phone, and address details can be optionally provided.

Input Parameters

string
City of the contact.
string
required
Email address of the contact (required).
string
Phone number of the contact.
string
State or province of the contact.
string
Company name associated with the contact.
string
Country of the contact.
string
Timezone of the contact.
string
Job title of the contact.
string
required
Last name of the contact (required).
string
Postal or ZIP code of the contact.
string
required
First name of the contact (required).
string
Salutation/title for the contact.
string
Mobile phone number of the contact.
string
Street address of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_CREATE_USERAdd or invite a user to a OnceHub account using their first name, last name, and email, with an optional role. An invitation email is sent to the user.

Input Parameters

string
required
Email address of the user (required).
string
required
Last name of the user (required).
string
Role name for the user (e.g., ‘Member’, ‘Admin’). If not specified, the default role will be assigned.
string
required
First name of the user (required).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_DELETE_CONTACTTool to delete a contact by ID from OnceHub. Use when you need to permanently remove a contact from the system.

Input Parameters

string
required
The unique identifier of the contact to delete (e.g., ‘CTC-GLJV69KW2LU30W’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_DELETE_USERTool to delete a user account from OnceHub. Use when you need to permanently remove a user from the system.

Input Parameters

string
required
The unique identifier of the user to delete (e.g., ‘USR-7R1P5GMSXE’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_GET_AVAILABLE_TIME_SLOTSTool to retrieve available time slots for a booking calendar from OnceHub. Use when you need to check availability for scheduling appointments within a specific date range (maximum 30 days). Returns real-time availability based on booking rules and participant calendars.

Input Parameters

string
required
The ID of the booking calendar to query for available time slots. Format: ‘BKC-’ followed by alphanumeric string (e.g., ‘BKC-ZK6W94KE6W’)
string
required
The end of the time range to search for available slots. Must be in ISO 8601 full form UTC format (e.g., ‘2024-11-29T09:30:00.000Z’ or ‘2025-12-29T23:59:59Z’). Must be within 30 days of start_time.
string
required
The beginning of the time range to search for available slots. Must be in ISO 8601 full form UTC format (e.g., ‘2024-11-29T09:30:00.000Z’ or ‘2025-12-22T00:00:00Z’). Cannot be more than 30 days before end_time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_GET_SINGLE_BOOKINGRetrieve a single OnceHub booking by ID, including timing, customer information, location, status, and form submission data.

Input Parameters

string
required
The booking identifier. Format: ‘BKNG-’ followed by alphanumeric string (e.g., ‘BKNG-J4FR05BKEWEX’)
string
Comma-separated list of embedded objects to expand into full objects. Expandable objects include: ‘booking_page’, ‘event_type’, ‘master_page’, ‘owner’. Maximum expansion depth is 2 levels. Example: ‘booking_page,event_type’. Note: Expanding data causes additional lookups and may result in slower response times.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_GET_SINGLE_BOOKING_CALENDARTool to retrieve a single booking calendar by ID from OnceHub. Use when you need to fetch detailed information about a specific booking calendar including its subject, name, URL, host, published status, and duration.

Input Parameters

string
required
The unique identifier of the booking calendar to retrieve (e.g., ‘BKC-ZK6W94KE6W’ or ‘BKC-LDJ878496X’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_GET_SINGLE_CONTACTRetrieve a single OnceHub contact by ID, including personal information, location data, and custom fields.

Input Parameters

string
required
The unique identifier of the contact to retrieve (e.g., ‘CTC-J4FR05BKEW’ or ‘CTC-GLJV69KW2LU30W’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_GET_SINGLE_MASTER_PAGETool to retrieve a single master page by ID from OnceHub. Use when you need to fetch complete master page details including name, label, URL, and active status.

Input Parameters

string
required
The unique identifier of the master page to retrieve. Format: MP-XXXXXXXXXXXX (e.g., ‘MP-73E6RHFU77’ or ‘MP-TEST123456’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_GET_SINGLE_USERTool to retrieve a single user by ID from OnceHub. Use when you need to fetch detailed information about a specific user including their name, email, status, role, timezone, and team associations.

Input Parameters

string
required
The unique identifier of the user to retrieve (e.g., ‘USR-GB59HWQCXF’ or ‘USR-FSD423423’)
string
Comma-separated list of embedded objects to expand in the response. By default, embedded objects are collapsed to their IDs. Example: ‘teams’. Maximum expansion depth is 2 levels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_GET_USER_SCHEDULING_AVAILABILITYTool to get user scheduling availability from OnceHub. Use when you need to retrieve a user’s weekly schedule, working hours, and any date-specific overrides.

Input Parameters

string
required
The unique identifier of the user (e.g., ‘USR-GB59HWQCXF’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_LIST_ALL_BOOKING_CALENDARSTool to list all booking calendars in the account. Use when you need to retrieve all booking calendars with optional cursor-based pagination.

Input Parameters

string
Object ID for cursor-based pagination. Returns objects after this ID in reverse chronological order. Mutually exclusive with ‘before’.
integer
Number of objects to return, between 1-100. Default is 10.
string
Object ID for cursor-based pagination. Returns objects before this ID in reverse chronological order. Mutually exclusive with ‘after’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_LIST_ALL_BOOKING_PAGESTool to list all booking pages in the account. Use when you need to retrieve all booking pages with optional cursor-based pagination.

Input Parameters

string
Object ID for cursor-based pagination. Returns objects after this ID in reverse chronological order. Mutually exclusive with ‘before’.
integer
Number of objects to return, between 1-100. Default is 10.
string
Object ID for cursor-based pagination. Returns objects before this ID in reverse chronological order. Mutually exclusive with ‘after’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_LIST_ALL_BOOKINGSTool to list all bookings in the account. Use when you need to retrieve bookings with optional filtering by time ranges, pagination, or expansion of related objects.

Input Parameters

string
Object ID for cursor-based pagination. Returns objects after this ID.
integer
Number of objects to return, between 1-100. Default is 10.
string
Object ID for cursor-based pagination. Returns objects before this ID. Mutually exclusive with ‘after’.
string
Comma-separated list of objects to expand (e.g., ‘booking_page’, ‘event_type’, ‘master_page’, ‘owner’). By default, embedded objects return only IDs.
string
Filter bookings created after specified time (ISO 8601 format).
string
Filter bookings with starting time greater than specified timestamp (ISO 8601 format).
string
Filter bookings with starting time less than specified timestamp (ISO 8601 format).
string
Filter bookings updated after specified time (ISO 8601 format). Includes new, canceled, rescheduled, no-show, and completed bookings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_LIST_ALL_CONTACTSList contacts in the OnceHub account, with optional creation-time and update-time filters and cursor-based pagination.

Input Parameters

string
Object ID for cursor-based pagination. Returns objects after this ID in reverse chronological order.
integer
Number of objects to return, between 1-100. Default is 10.
string
Object ID for cursor-based pagination. Returns objects before this ID in reverse chronological order. Mutually exclusive with ‘after’.
string
Filter contacts created after specified timestamp (ISO 8601 format).
string
Filter contacts created before specified timestamp (ISO 8601 format).
string
Filter contacts updated after specified timestamp (ISO 8601 format).
string
Filter contacts updated before specified timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_LIST_ALL_EVENT_TYPESTool to list all event types in the account. Use when you need to retrieve all event types with optional cursor-based pagination to understand available event type options.

Input Parameters

string
Object ID for cursor-based pagination. Returns objects after this ID in reverse chronological order. Mutually exclusive with ‘before’.
integer
Number of objects to return, between 1-100. Default is 10.
string
Object ID for cursor-based pagination. Returns objects before this ID in reverse chronological order. Mutually exclusive with ‘after’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_LIST_ALL_MASTER_PAGESTool to list all master pages in the account. Use when you need to retrieve all master pages with optional cursor-based pagination.

Input Parameters

string
Object ID for cursor-based pagination. Returns objects after this ID in reverse chronological order. Mutually exclusive with ‘before’.
integer
Number of objects to return, between 1-100. Default is 10.
string
Object ID for cursor-based pagination. Returns objects before this ID in reverse chronological order. Mutually exclusive with ‘after’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_LIST_ALL_TEAMSTool to list all teams in the OnceHub account. Use when you need to retrieve team information with optional cursor-based pagination.

Input Parameters

string
Object ID for cursor-based pagination. Returns objects after this ID in reverse chronological order.
integer
Number of objects to return, between 1-100. Default is 25.
string
Object ID for cursor-based pagination. Returns objects before this ID in reverse chronological order. Mutually exclusive with ‘after’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_LIST_ALL_USERSTool to list all users in the OnceHub account. Use when you need to retrieve user information with optional cursor-based pagination.

Input Parameters

string
Object ID for cursor-based pagination. Returns objects after this ID in reverse chronological order.
integer
Number of objects to return, between 1-100. Default is 10.
string
Object ID for cursor-based pagination. Returns objects before this ID in reverse chronological order. Mutually exclusive with ‘after’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_MARK_BOOKING_AS_NO_SHOWTool to mark a completed booking as no-show in OnceHub. Use when the customer did not attend the scheduled meeting and you need to update the booking status to reflect the no-show.

Input Parameters

string
required
The unique identifier of the booking to mark as no-show (e.g., ‘BKNG-J4FR05BKEWEX’). The booking must exist and be in a valid state to be marked as no-show.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_TEST_API_KEYTool to validate API key authentication for OnceHub. Use when you need to verify that your API key is valid and active before making other API calls to the platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_UPDATE_CONTACTUpdate an existing ScheduleOnce contact’s name, company, or phone number. The contact’s email cannot be updated through this endpoint.

Input Parameters

string
required
Unique identifier of the contact to update (e.g., ‘CTC-W35G2NEQ2PC6QX’).
string
Updated email address of the contact.
string
Updated phone number of the contact.
string
Updated company name associated with the contact.
string
Updated last name of the contact.
string
Updated first name of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_UPDATE_USERTool to update an existing user in OnceHub. Use when you need to modify user information such as name, email, role, or timezone.

Input Parameters

string
required
The unique identifier of the user to update (e.g., ‘USR-DQ27BRAJ4L’).
string
Updated email address of the user.
string
Updated timezone for the user (e.g., ‘America/Chicago’, ‘Europe/London’).
string
Updated last name of the user.
string
Updated role name for the user (e.g., ‘Member’, ‘Admin’).
string
Updated first name of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCHEDULEONCE_UPDATE_USER_SCHEDULING_AVAILABILITYUpdate a user’s weekly scheduling availability and date-specific overrides in OnceHub. Each supplied weekday or override date completely replaces its existing schedule.

Input Parameters

string
required
The unique identifier of the user (e.g., ‘USR-GB59HWQCXF’)
array
required
Weekly schedule containing availability for each day of the week. Must include entries for all 7 days.
string
required
Timezone for the scheduling availability (e.g., ‘America/New_York’, ‘Asia/Kolkata’). Must be a valid IANA timezone identifier.
array
List of specific date overrides that modify the weekly schedule. Use this for holidays, vacation days, or special availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not