Authorization
Your request should contain the header: 'X-API-KEY'.
Note: This is a Paid plan feature.
API key will become automatically available on your Integrations page as soon as you upgrade.
Base url
https://secure.simplymeet.me
HTTP Request example:
POST https://secure.simplymeet.me/panel/api/event/cancel/123
Content-Type: application/json
X-API-KEY: <insert your X-API-KEY here>
{
"reason": "<insert your reason here>",
}
Methods
-
Get list of ACL rules
Returns list of ACL rulesEndpoint:
/panel/api/aclMethod:
getReturn:
-
Save availability rule
Saves the availability ruleEndpoint:
/panel/api/availability-ruleMethod:
putRequest parameters:
AvailabilityRuleRequestDTO body - Availability rule dataReturn:
Returns empty response when the operation is successful -
Get organization cancellation policy
Returns the cancellation policy of the organizationEndpoint:
/panel/api/organization-cancellation-policyMethod:
getReturn:
-
Update organization cancellation policy
Updates the cancellation policy of the organizationEndpoint:
/panel/api/organization-cancellation-policyMethod:
putRequest parameters:
CancellationPolicyRequestDTO body - Cancellation policy dataReturn:
-
Get user cancellation policy
Returns the cancellation policy of the userEndpoint:
/panel/api/user-cancellation-policyMethod:
getReturn:
-
Update user cancellation policy
Updates the cancellation policy of the userEndpoint:
/panel/api/user-cancellation-policyMethod:
putRequest parameters:
CancellationPolicyRequestDTO body - Cancellation policy dataReturn:
-
Delete event list
Delete event list by idsEndpoint:
/panel/api/event/delete-listMethod:
deleteRequest parameters:
DeleteEventListRequestDTO body - An array of integers representing the IDs of the events to be deletedReturn:
Returns empty response when the operation is successful -
Cancel event list
Cancel event list by idsEndpoint:
/panel/api/event/cancel-listMethod:
putRequest parameters:
CancelEventListRequestDTO body - An object containing an array of event IDs to be cancelled and an optional reason for the cancellationReturn:
Returns empty response when the operation is successful -
Create event
Create event by request paramsEndpoint:
/panel/api/eventMethod:
postRequest parameters:
CreateEventRequestDTO body - An object containing the event detailsReturn:
-
Get event
Get event by idEndpoint:
/panel/api/event/{id}Method:
getRequest parameters:
int id - The id of the eventReturn:
-
Edit event
Edit event by request params and IDEndpoint:
/panel/api/event/{id}Method:
putRequest parameters:
int id - The id of the eventEditEventRequestDTO body - An object containing the event detailsReturn:
void -
Delete event
Delete event by idEndpoint:
/panel/api/event/{id}Method:
deleteRequest parameters:
int id - The id of the eventReturn:
Returns empty response when the operation is successful -
Cancel event
Cancel event by idEndpoint:
/panel/api/event/cancel/{id}Method:
putRequest parameters:
int id - The id of the eventCancelEventRequestDTO body - An object containing the reason for the cancellationReturn:
Returns empty response when the operation is successful -
Edit event notes
Edit event notes by idEndpoint:
/panel/api/event/notes/{id}Method:
putRequest parameters:
int id - The id of the eventEventEditNotesRequestDTO body - An object containing the notes for the eventReturn:
Returns empty response when the operation is successful -
Get list of events
Get list of events by request paramsEndpoint:
/panel/api/event/Method:
getRequest parameters:
GetEventListRequestDTO query - An object containing the request parameters for fetching the list of eventsReturn:
{meta: MetaDataDTOitems: EventDTO[]} -
No show event
No show event by idEndpoint:
/panel/api/event/no-show/{id}Method:
putRequest parameters:
int id - The id of the eventReturn:
Returns empty response when the operation is successful -
No show event list
No show event list by idsEndpoint:
/panel/api/event/no-show-listMethod:
putRequest parameters:
NoShowEventListRequestDTO body - An object containing an array of event IDs to be no-showedReturn:
Returns empty response when the operation is successful -
Resend event notification
Resend event notification by idEndpoint:
/panel/api/event/resend-notification/{id}Method:
putRequest parameters:
int id - The id of the eventReturn:
Returns empty response when the operation is successful -
Invite participants to event
Invite participants to event by idEndpoint:
/panel/api/event/invite-participants/{id}Method:
postRequest parameters:
int id - The id of the eventEventInviteParticipantsRequestDTO body - An object containing an array of participant emails and an optional message for the invitationReturn:
Returns empty response when the operation is successful -
Reschedule event
Reschedule event by idEndpoint:
/panel/api/event/reschedule/{id}Method:
putRequest parameters:
int id - The id of the eventRescheduleEventRequestDTO body - An object containing the new date and time for the event, the event type ID, and an optional user IDReturn:
Returns empty response when the operation is successful -
Get list of event types
Get list of event types by request paramsEndpoint:
/panel/api/event-typeMethod:
getRequest parameters:
GetEventTypeListRequestDTO query - An object containing the request parameters for fetching the list of event typesReturn:
-
Get event type availability
Get event type availability by request paramsEndpoint:
/panel/api/event-type/availability/{id}Method:
getRequest parameters:
int id - The id of the event typeGetEventTypeAvailabilityRequestDTO query - An object containing the request parameters for fetching the availability of the event typeReturn:
-
Get event type
Get event type by idEndpoint:
/panel/api/event-type/{id}Method:
getRequest parameters:
int id - The id of the event typeReturn:
-
Add event type tag to event type
Add event type tag to event type descriptionEndpoint:
/panel/api/event-type-tag/{eventTypeId}/{tagId}Method:
putRequest parameters:
int eventTypeId - The id of the event typeint tagId - The id of the tagReturn:
Returns empty response when the operation is successful -
Remove event type tag
Remove event type tag by event type id and tag idEndpoint:
/panel/api/event-type-tag/{eventTypeId}/{tagId}Method:
deleteRequest parameters:
int eventTypeId - The id of the event typeint tagId - The id of the tagReturn:
Returns empty response when the operation is successful -
Get event type tag list
Get event type tag list by event type idEndpoint:
/panel/api/event-type-tag/{eventTypeId}Method:
getRequest parameters:
int eventTypeId - The id of the event typeReturn:
-
Get list of integrations
Returns list of integrationsEndpoint:
/panel/api/integrationMethod:
getReturn:
-
Retrieve a poll by ID
Retrieves a poll based on the provided IDEndpoint:
/panel/api/poll/{id}Method:
getRequest parameters:
int id - ID of the pollReturn:
-
Delete a poll
Delete a poll by IDEndpoint:
/panel/api/poll/{id}Method:
deleteRequest parameters:
int id - ID of the pollReturn:
Returns empty response when the operation is successful -
Create a poll result
Create a poll result with the provided request dataEndpoint:
/panel/api/poll/poll-resultMethod:
postRequest parameters:
PollResultRequestDTO body - The request data for creating a poll resultReturn:
Returns empty response when the operation is successful -
Create a new poll
Create a new poll with the provided request dataEndpoint:
/panel/api/pollMethod:
postRequest parameters:
PollRequestDTO body - The request data for creating a new pollReturn:
-
Get list of polls
Get list of polls by request paramsEndpoint:
/panel/api/pollMethod:
getRequest parameters:
GetPollListRequestDTO request - The request parameters for fetching the list of pollsReturn:
PollDTO[] -
Create a single use link
Create a single use link for an event typeEndpoint:
/panel/api/single-use-link/{id}Method:
postRequest parameters:
int id - ID of the event typeReturn:
-
Get current user
Returns the current userEndpoint:
/panel/api/current-userMethod:
getReturn:
-
Get user list
Returns the list of usersEndpoint:
/panel/api/userMethod:
getReturn:
UserDTO[] -
Get user event type tag list
Returns the list of user event type tagsEndpoint:
/panel/api/user-event-type-tagMethod:
getReturn:
UserEventTypeTagDTO[] -
Create user event type tag
Creates a new user event type tagEndpoint:
/panel/api/user-event-type-tagMethod:
postRequest parameters:
UserEventTypeTagRequestDTO body - User event type tag dataReturn:
UserEventTypeTagDTO -
Update user event type tag
Updates the specified user event type tagEndpoint:
/panel/api/user-event-type-tag/{id}Method:
putRequest parameters:
int id - The ID of the user event type tag to updateUserEventTypeTagRequestDTO body - User event type tag dataReturn:
UserEventTypeTagDTO -
Delete user event type tag
Deletes the specified user event type tagEndpoint:
/panel/api/user-event-type-tag/{id}Method:
deleteRequest parameters:
int id - The ID of the user event type tag to deleteReturn:
Successful operation
Acl
Availability rule
Cancellation Policy
Meeting
Meeting type
Meeting type tag
Integration
Poll
Single use link
User
User meeting type tag
-
AclRuleDTO
Access Control List Rule schemaName Type Description resource string Resource name attributes array Resource attributes allowedAttributes array Allowed attributes for current user -
AnswerDTO
AnswerName Type Description id int The unique identifier of the answer. questionLabel string The label of the question. questionType string The type of the question. value string The value of the answer. plainValue string The plain value of the answer. questionUuid string questionUuid -
AnswerRequestDTO
Answer request schemaName Type Description value string Answer value question string Question UUID -
AvailabilityRuleDTO
Availability RuleName Type Description type string The type of the availability rule. hourIntervals HourIntervalDTO[] The hour intervals of the availability rule. config object The configuration of the availability rule. Example: {date: '2023-11-16'} or {weekday: 'wednesday'} -
AvailabilityRuleRequestDTO
Availability Rule RequestName Type Description eventTypeIds array The event type IDs. availabilityRules AvailabilityRuleDTO[] The availability rules. periodType string The type of the period. periodTypeConfig object The configuration of the period type. Example: {start: '2022-01-01', end: '2022-12-31'} availabilityType string Save only for weekday or date availability type. If not set, it will be saved for both types -
CancelEventListRequestDTO
Cancel event list request schemaName Type Description ids array Event ids reason string Reason of cancellation. -
CancelEventRequestDTO
Cancel event request schemaName Type Description reason string Reason of cancellation. -
CancellationDTO
CancellationName Type Description id int The unique identifier of the cancellation. canceler string The user of the cancellation. reason string The reason of the cancellation. -
CancellationPolicyDTO
Cancellation policy data transfer objectName Type Description enabled bool Enabled status period int Cancellation policy period in minutes label string Cancellation policy label text string Cancellation policy text version int Version type string Type of the cancellation policy. Can be 'user' or 'organization' overwrite_personal bool Overwrite personal cancellation policy -
CancellationPolicyRequestDTO
Cancellation policy request DTOName Type Description enabled bool Enabled status period int Cancellation policy period in minutes label string Cancellation policy label text string Cancellation policy text overwritePersonal bool Overwrite personal cancellation policy -
CreateEventRequestDTO
Create event request schemaName Type Description scheduledAt string Start date and time. Format: Y-m-d H:i:s multipleScheduledAt array Array of start dates and times. eventType int Event type id assigned to event. invitee InviteeRequestDTO Invitee data durationId int Duration id answers AnswerRequestDTO[] Answers participants ParticipantRequestDTO[] Participants locationType string Location type location string Location -
DeleteEventListRequestDTO
Delete event list request schemaName Type Description ids array Event ids -
EditEventAnswerRequestDTO
EditEventAnswerRequestDTOName Type Description id int Answer id. value string Answer value -
EditEventInviteeRequestDTO
EditEventInviteeRequestDTOName Type Description fullName string The full name of the invitee. phoneNumber string The phone number of the invitee. -
EditEventRequestDTO
EditEventRequestDTOName Type Description id int Event id. Ignore this field. invitee InviteeRequestDTO">EditEventInviteeRequestDTO Invitee data answers EditEventAnswerRequestDTO[] Answers -
EventDTO
Event DTOName Type Description id int Event ID uuid string Event UUID user UserDTO User DTO object (event owner) eventType EventTypeDTO Event type DTO object invitee InviteeDTO Invitee DTO object cancellation CancellationDTO Cancellation DTO object participants ParticipantDTO[] Array of Participant DTO objects answers AnswerDTO[] Array of Answer DTO objects rescheduling ReschedulingDTO[] Array of Rescheduling DTO objects payment EventPaymentDTO Event payment DTO object createdAt string The date and time when the event was created. updatedAt string The date and time when the event was last updated. scheduledAt string The date and time when the event was scheduled. endDate string The date and time when the event was ended. canceledAt string The date and time when the event was canceled. state string Event state notes string Event notes details string Event details location string Event location locationType string Event location type onlineEventId string Online event ID sentEmailReminder int Sent email reminder lastSentInviteeEmailReminder int Last sent invitee email reminder lastSentInviteeEmailFollowUp int Last sent invitee email follow up duration int Event duration users UserDTO[] Array of UserDTO objects assigned to the event -
EventEditNotesRequestDTO
Event edit notes request schemaName Type Description notes string Notes. -
EventInviteParticipantsRequestDTO
Event invite participants request schemaName Type Description emails array Emails message string Message -
EventPaymentDTO
EventPaymentDTOName Type Description provider string provider amount number amount currency string currency status string status system string system referenceId int referenceId overwritePersonal bool overwritePersonal -
EventTypeAvailabilityDTO
Event Type AvailabilityName Type Description date string The date of the availability hours EventTypeAvailabilityHoursDTO[] Array of availability hours available bool Indicates if the date is available -
EventTypeAvailabilityHoursDTO
Event Type Availability HoursName Type Description start string The start time of the availability hour available bool Indicates if the hour is available -
EventTypeDTO
Event type DTOName Type Description id int Unique identifier for the event type name string Name of the event type color string Color user UserDTO User DTO object (event type owner) type string Type: regular, round-robin, collective duration int Duration in minutes slug string Slug (unique identifier for the event type) amount number Amount currency string Currency locationType string Location type: 'custom', 'zoom', 'request', 'whereby', 'google_meet', 'kopano_meet', 'microsoft_teams' location string Event location - custom text isEnabled bool Flag to indicate if the event type is enabled isSecret bool Flag to indicate if the event type is secret users UserDTO[] Array of UserDTO objects assigned to the event type timezone string Timezone isLocalized bool Flag to indicate if the event type show booking page in client timezone durationType string Duration type: fixed or flexible eventTypeDurations EventTypeDurationDTO[] Flexible durations position int Position eventTypeRequestLocationTypes EventTypeRequestLocationTypeDTO[] Request location types uuid string UUID attribute isAllowCancel bool Display cancellation link in notifications isAllowReschedule bool Display reschedule link in notifications isShowPhone bool Flag to indicate if phone is to be shown isPhoneFieldRequired bool Flag to indicate if phone field is required questions QuestionDTO[] Event type questions isMultipleMeeting bool Flag to indicate if multiple events are allowed (Allow clients to book multiple event slots) locationLabel string Location question if location type = request groupMeetingLimit int Group meeting limit showGroupMeetingRest bool Show group meeting rest -
EventTypeDurationDTO
EventTypeDurationDTOName Type Description id int The unique identifier of the duration. duration int Duration in minutes -
EventTypeRequestLocationTypeDTO
EventTypeRequestLocationTypeDTOName Type Description id int The unique identifier locationType string Location type: 'custom', 'zoom', 'request', 'whereby', 'google_meet', 'kopano_meet', 'microsoft_teams' -
EventTypeTagDTO
Event Type TagName Type Description id int The id of the event type tag name string The name of the event type tag color string The color of the event type tag position int The position of the event type tag enabled bool Indicates if the event type tag is enabled -
GetEventListFilterDTO
Get Event List FilterName Type Description ids array Event ids eventTypeType string Event type type state string Event state paymentStatus string Payment status invitee string Invitee (email or name) uuid string Event uuid eventTypeList array Event type ids userList array User ids organizationTagList array Organization tag ids scheduledAtFrom string Scheduled at from: YYYY-MM-DD scheduledAtTo string Scheduled at to: YYYY-MM-DD -
GetEventListRequestDTO
Get Event List RequestName Type Description page int Page number for pagination. Should be greater than 0. onPage int Number of items per page. Should be greater than 0 and less than or equal to 100. orderField string Field to use for sorting. orderDirection string Sort direction. Should be either 'asc' (ascending) or 'desc' (descending). skipPagination bool Flag to skip pagination. groupBy string Field to use for grouping. GetEventListFilterDTO GetEventListFilterDTO Filter for getting event list -
GetEventTypeAvailabilityRequestDTO
Get Event Type Availability RequestName Type Description id int The id of the event type startDate string The start date of the availability endDate string The end date of the availability timezone string The timezone of the availability durationId int The id of the duration userId int The id of the user -
GetEventTypeListFilterDTO
Get Event Type List FilterName Type Description ids array Event type ids forCurrentUser bool Get event types for current user manageRoundRobin bool To retrieve a list of event types that a user can edit. type string Event type type -
GetEventTypeListRequestDTO
Get Event Type List RequestName Type Description page int Page number for pagination. Should be greater than 0. onPage int Number of items per page. Should be greater than 0 and less than or equal to 100. orderField string Field to use for sorting. orderDirection string Sort direction. Should be either 'asc' (ascending) or 'desc' (descending). skipPagination bool Flag to skip pagination. groupBy string Field to use for grouping. filter GetEventTypeListFilterDTO Filter for getting event type list -
GetPollListRequestDTO
GetPollListRequestDTOName Type Description page int Page number for pagination. Should be greater than 0. onPage int Number of items per page. Should be greater than 0 and less than or equal to 100. orderField string Field to use for sorting. orderDirection string Sort direction. Should be either 'asc' (ascending) or 'desc' (descending). skipPagination bool Flag to skip pagination. groupBy string Field to use for grouping. -
HourIntervalDTO
Hour IntervalName Type Description start string The start time of the interval. end string The end time of the interval. -
IntegrationListDTO
Integration list data transfer objectName Type Description user array User integrations organization array Organization integrations -
InviteeDTO
InviteeName Type Description id int The unique identifier of the invitee. email string The email address of the invitee. fullName string The full name of the invitee. timezone string The timezone of the invitee. phoneNumber string The phone number of the invitee. locale string The locale of the invitee. cancellationPolicy string The cancellation policy of the invitee. uuid string The UUID of the invitee -
InviteeRequestDTO
Invitee request schemaName Type Description fullName string Full name email string Email timezone string Timezone locale string Locale phoneNumber string Phone number cancellationPolicy string Cancellation policy -
MetaDataDTO
Metadata for the paginated resultName Type Description pagesCount int The total number of pages itemsPerPage int The number of items per page itemsCount int The total number of items currentPage int The current page -
NoShowEventListRequestDTO
No show event list request schemaName Type Description ids array Event ids -
OrganizationDTO
OrganizationDTOName Type Description id int The unique identifier of the organization. uuid string The unique UUID identifier of the organization. slug string Slug (unique identifier for the organization) name string The name of the organization. createdAt string The date and time when the organization was created. locale string The locale of the organization. rtl bool The right-to-left layout of the organization. calendarLayout string The calendar layout of the organization. hideUnavailableDates bool Hide unavailable dates. sundayIsFirstDay bool Sunday is the first day of the week. email string The email associated with the organization. intro string The intro associated with the organization. domain string The custom domain associated with the organization. socialLink SocialLinkDTO The social links associated with the organization. -
ParticipantDTO
ParticipantName Type Description id int The unique identifier of the participant. email string The email address of the participant. createdAt string The creation date of the participant. -
ParticipantRequestDTO
Participant request schemaName Type Description email string Email -
PollAvailabilityDTO
Data Transfer Object (DTO) for Poll AvailabilityName Type Description id int Poll ID date string Poll date in ISO 8601 format (e.g., 2023-12-31T23:59:59+00:00) results PollResultDTO[] Poll results -
PollAvailabilityRequestDTO
Poll availability request schemaName Type Description date string The date for checking poll availability -
PollDTO
Data Transfer Object (DTO) for PollName Type Description id int Poll ID uuid string Poll UUID user user user eventType eventType eventType voteVisibility bool Visibility of the poll vote commentVisibility bool Visibility of the poll comment emailNotification bool Email notification for the poll duration int Duration of the poll in minutes name string Name of the poll createdAt string Creation date of the poll in ISO 8601 format availability PollAvailabilityDTO">PollAvailabilityDTO[] Array of availability slots for the poll -
PollRequestDTO
Poll request schemaName Type Description eventTypeId int Event type ID for the poll voteVisibility bool Visibility of the poll vote commentVisibility bool Visibility of the poll comment emailNotification bool Email notification for the poll duration int Duration of the poll in minutes name string Name of the poll availability PollAvailabilityRequestDTO[] Array of availability slots for the poll -
PollAvailabilityDTO
Data Transfer Object (DTO) for Poll ResultName Type Description email string Email address of the client comment string Comment of the client -
PollResultRequestDTO
Poll result request schemaName Type Description uuid string Poll UUID availability array Availability ids email string email comment string comment -
QuestionDTO
QuestionDTOName Type Description label string The label of the question. type string The type of the question. required bool Determines if the question is required or not. config array Question config. [{label: 'value'}, {label: 'value'}] uuid string The unique identifier of the question. position int The position/order of the question. -
RescheduleEventRequestDTO
Reschedule event request schemaName Type Description start string Start date and time. Format: Y-m-d H:i:s end string End date and time. Format: Y-m-d H:i:s eventTypeId int Event type id assigned to event. userId int User id assigned to event. -
ReschedulingDTO
ReschedulingName Type Description id int The unique identifier of the rescheduling. rescheduler string The user of the rescheduling. reason string The reason of the rescheduling. previouslyScheduledAt string The date and time of the rescheduling. previousUser UserDTO The user of the previous appointment. -
SimpleEventTypeDTO
SimpleEventTypeDTOName Type Description id int id name string name color string color location_type string location_type timezone string timezone user_full_name string user_full_name localized bool localized -
SimpleUserDTO
SimpleUserDTOName Type Description id int id email string email fullName string fullName -
SingleUseLinkDTO
Single use link response schemaName Type Description code string The code of the single use link url string The URL of the single use link -
SocialLinkDTO
SocialLinkDTOName Type Description id int The unique identifier of the social link. facebookUrl string The URL of the Facebook profile. twitterUrl string The URL of the Twitter profile. instagramUrl string The URL of the Instagram profile. linkedinUrl string The URL of the LinkedIn profile. whatsappUrl string The URL of the WhatsApp profile. -
UserDTO
UserName Type Description id int The unique identifier of the user. uuid string The UUID of the user email string The email address of the user. fullName string The full name of the user. slug string Slug (unique identifier for the user) subscriptionUsersLimit int The limit of users that can be added to the subscription. isSecondFactorConfigured bool Determines if the second factor authentication is configured for the user. isEnabled bool Determines if the user account is enabled or not. dateFormat string The date format of the user. address string The address of the user. state string The state of the user's address. city string The city of the user's address. zip string The zip code of the user's address. countryId string The country ID of the user's address. lat number The latitude coordinate of the user's location. lng number The longitude coordinate of the user's location. domain string The custom domain associated with the user. phone string The phone number associated with the user. companyLogoName string The name of the company logo associated with the user. avatarName string The name of the avatar associated with the user. organization OrganizationDTO The organization details associated with the user. createdAt string The date and time when the user was created. lastLogin string The date and time of the user's last login. connections array List of OAuth connections hasPaidSubscription bool Determines if the user has a paid subscription. timezone string timezone timeFormat string timeFormat timezoneOffset string timezoneOffset -
UserEventTypeTagDTO
User Event Type TagName Type Description id int The unique identifier of the event type tag. name string The name of the event type tag. color string The color of the event type tag. position int The position of the event type tag. user UserDTO The user associated with the event type tag. -
UserEventTypeTagRequestDTO
User Event Type Tag RequestName Type Description position int The position of the event type tag. name string The name of the event type tag. color string The color of the event type tag.