API ドキュメント | SimplyMeet.me オンラインスケジュール

認証

リクエストにはヘッダー 'X-API-KEY' が含まれている必要があります。

注: これは、有料プランの機能です。

API キーは、アップグレードするとすぐに連携ページで自動的に利用可能になります。

ベースURL

https://secure.simplymeet.me

HTTPリクエスト例:

                        
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>",
}

ACL

Get list of ACL rules

Returns list of ACL rules

エンドポイント:

/panel/api/acl

方法:

get

戻る:

AclRuleDTO[]

予約可能な時間枠の設定ルール

Save availability rule

Saves the availability rule

エンドポイント:

/panel/api/availability-rule

方法:

put

リクエストパラメーター:

AvailabilityRuleRequestDTO body - Availability rule data

戻る:

Returns empty response when the operation is successful

キャンセルポリシー

Get organization cancellation policy

Returns the cancellation policy of the organization

エンドポイント:

/panel/api/organization-cancellation-policy

方法:

get

戻る:

CancellationPolicyDTO
Update organization cancellation policy

Updates the cancellation policy of the organization

エンドポイント:

/panel/api/organization-cancellation-policy

方法:

put

リクエストパラメーター:

CancellationPolicyRequestDTO body - Cancellation policy data

戻る:

CancellationPolicyDTO
Get user cancellation policy

Returns the cancellation policy of the user

エンドポイント:

/panel/api/user-cancellation-policy

方法:

get

戻る:

CancellationPolicyDTO
Update user cancellation policy

Updates the cancellation policy of the user

エンドポイント:

/panel/api/user-cancellation-policy

方法:

put

リクエストパラメーター:

CancellationPolicyRequestDTO body - Cancellation policy data

戻る:

CancellationPolicyDTO

ミーティング

Cancel event

Cancel event by id

エンドポイント:

/panel/api/event/cancel/{id}

方法:

put

リクエストパラメーター:

int id - The id of the event

CancelEventRequestDTO body - An object containing the reason for the cancellation

戻る:

Returns empty response when the operation is successful
Cancel event list

Cancel event list by ids

エンドポイント:

/panel/api/event/cancel-list

方法:

put

リクエストパラメーター:

CancelEventListRequestDTO body - An object containing an array of event IDs to be cancelled and an optional reason for the cancellation

戻る:

Returns empty response when the operation is successful
Create event

Create event by request params

エンドポイント:

/panel/api/event

方法:

post

リクエストパラメーター:

CreateEventRequestDTO body - An object containing the event details

戻る:

EventDTO
Get event

Get event by id

エンドポイント:

/panel/api/event/{id}

方法:

get

リクエストパラメーター:

int id - The id of the event

戻る:

EventDTO
Edit event

Edit event by request params and ID

エンドポイント:

/panel/api/event/{id}

方法:

put

リクエストパラメーター:

int id - The id of the event

EditEventRequestDTO body - An object containing the event details

戻る:

void
Delete event

Delete event by id

エンドポイント:

/panel/api/event/{id}

方法:

delete

リクエストパラメーター:

int id - The id of the event

戻る:

Returns empty response when the operation is successful
Delete event list

Delete event list by ids

エンドポイント:

/panel/api/event/delete-list

方法:

delete

リクエストパラメーター:

DeleteEventListRequestDTO body - An array of integers representing the IDs of the events to be deleted

戻る:

Returns empty response when the operation is successful
Edit event notes

Edit event notes by id

エンドポイント:

/panel/api/event/notes/{id}

方法:

put

リクエストパラメーター:

int id - The id of the event

EventEditNotesRequestDTO body - An object containing the notes for the event

戻る:

Returns empty response when the operation is successful
Invite participants to event

Invite participants to event by id

エンドポイント:

/panel/api/event/invite-participants/{id}

方法:

post

リクエストパラメーター:

int id - The id of the event

EventInviteParticipantsRequestDTO body - An object containing an array of participant emails and an optional message for the invitation

戻る:

Returns empty response when the operation is successful
Get list of events

Get list of events by request params

エンドポイント:

/panel/api/event/

方法:

get

リクエストパラメーター:

GetEventListRequestDTO query - An object containing the request parameters for fetching the list of events

戻る:

{
meta: MetaDataDTO
items: EventDTO[]
}
No show event

No show event by id

エンドポイント:

/panel/api/event/no-show/{id}

方法:

put

リクエストパラメーター:

int id - The id of the event

戻る:

Returns empty response when the operation is successful
No show event list

No show event list by ids

エンドポイント:

/panel/api/event/no-show-list

方法:

put

リクエストパラメーター:

NoShowEventListRequestDTO body - An object containing an array of event IDs to be no-showed

戻る:

Returns empty response when the operation is successful
Reschedule event

Reschedule event by id

エンドポイント:

/panel/api/event/reschedule/{id}

方法:

put

リクエストパラメーター:

int id - The id of the event

RescheduleEventRequestDTO body - An object containing the new date and time for the event, the event type ID, and an optional user ID

戻る:

Returns empty response when the operation is successful
Resend event notification

Resend event notification by id

エンドポイント:

/panel/api/event/resend-notification/{id}

方法:

put

リクエストパラメーター:

int id - The id of the event

戻る:

Returns empty response when the operation is successful

会議タイプ

Get list of event types

Get list of event types by request params

エンドポイント:

/panel/api/event-type

方法:

get

リクエストパラメーター:

GetEventTypeListRequestDTO query - An object containing the request parameters for fetching the list of event types

戻る:

EventTypeDTO[]
Get event type availability

Get event type availability by request params

エンドポイント:

/panel/api/event-type/availability/{id}

方法:

get

リクエストパラメーター:

int id - The id of the event type

GetEventTypeAvailabilityRequestDTO query - An object containing the request parameters for fetching the availability of the event type

戻る:

EventTypeAvailabilityDTO[]
Get event type

Get event type by id

エンドポイント:

/panel/api/event-type/{id}

方法:

get

リクエストパラメーター:

int id - The id of the event type

戻る:

EventTypeDTO

会議タイプタグ

Add event type tag to event type

Add event type tag to event type description

エンドポイント:

/panel/api/event-type-tag/{eventTypeId}/{tagId}

方法:

put

リクエストパラメーター:

int eventTypeId - The id of the event type

int tagId - The id of the tag

戻る:

Returns empty response when the operation is successful
Remove event type tag

Remove event type tag by event type id and tag id

エンドポイント:

/panel/api/event-type-tag/{eventTypeId}/{tagId}

方法:

delete

リクエストパラメーター:

int eventTypeId - The id of the event type

int tagId - The id of the tag

戻る:

Returns empty response when the operation is successful
Get event type tag list

Get event type tag list by event type id

エンドポイント:

/panel/api/event-type-tag/{eventTypeId}

方法:

get

リクエストパラメーター:

int eventTypeId - The id of the event type

戻る:

EventTypeTagDTO[]

機能連携

Get list of integrations

Returns list of integrations

エンドポイント:

/panel/api/integration

方法:

get

戻る:

IntegrationListDTO

投票

Create a poll result

Create a poll result with the provided request data

エンドポイント:

/panel/api/poll/poll-result

方法:

post

リクエストパラメーター:

PollResultRequestDTO body - The request data for creating a poll result

戻る:

Returns empty response when the operation is successful
Get list of polls

Get list of polls by request params

エンドポイント:

/panel/api/poll

方法:

get

リクエストパラメーター:

GetPollListRequestDTO request - The request parameters for fetching the list of polls

戻る:

PollDTO[]
Create a new poll

Create a new poll with the provided request data

エンドポイント:

/panel/api/poll

方法:

post

リクエストパラメーター:

PollRequestDTO body - The request data for creating a new poll

戻る:

PollDTO
Retrieve a poll by ID

Retrieves a poll based on the provided ID

エンドポイント:

/panel/api/poll/{id}

方法:

get

リクエストパラメーター:

int id - ID of the poll

戻る:

PollDTO
Delete a poll

Delete a poll by ID

エンドポイント:

/panel/api/poll/{id}

方法:

delete

リクエストパラメーター:

int id - ID of the poll

戻る:

Returns empty response when the operation is successful

使い捨てリンク

Create a single use link

Create a single use link for an event type

エンドポイント:

/panel/api/single-use-link/{id}

方法:

post

リクエストパラメーター:

int id - ID of the event type

戻る:

SingleUseLinkDTO

ユーザー

Get current user

Returns the current user

エンドポイント:

/panel/api/current-user

方法:

get

戻る:

UserDTO
Get user list

Returns the list of users

エンドポイント:

/panel/api/user

方法:

get

戻る:

UserDTO[]

ユーザー予約タイプタグ

Get user event type tag list

Returns the list of user event type tags

エンドポイント:

/panel/api/user-event-type-tag

方法:

get

戻る:

UserEventTypeTagDTO[]
Create user event type tag

Creates a new user event type tag

エンドポイント:

/panel/api/user-event-type-tag

方法:

post

リクエストパラメーター:

UserEventTypeTagRequestDTO body - User event type tag data

戻る:

UserEventTypeTagDTO
Update user event type tag

Updates the specified user event type tag

エンドポイント:

/panel/api/user-event-type-tag/{id}

方法:

put

リクエストパラメーター:

int id - The ID of the user event type tag to update

UserEventTypeTagRequestDTO body - User event type tag data

戻る:

UserEventTypeTagDTO
Delete user event type tag

Deletes the specified user event type tag

エンドポイント:

/panel/api/user-event-type-tag/{id}

方法:

delete

リクエストパラメーター:

int id - The ID of the user event type tag to delete

戻る:

Successful operation

タイプ

AclRuleDTO

Access Control List Rule schema

宛先	タイプ	説明
resource	string	Resource name
attributes	array	Resource attributes
allowedAttributes	array	Allowed attributes for current user

AnswerDTO

Answer

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
value	string	Answer value
question	string	Question UUID

AvailabilityRuleDTO

Availability Rule

宛先	タイプ	説明
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 Request

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
ids	array	Event ids
reason	string	Reason of cancellation.

CancelEventRequestDTO

Cancel event request schema

宛先	タイプ	説明
reason	string	Reason of cancellation.

CancellationDTO

Cancellation

宛先	タイプ	説明
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 object

宛先	タイプ	説明
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 DTO

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
ids	array	Event ids

EditEventAnswerRequestDTO

宛先	タイプ	説明
id	int	Answer id.
value	string	Answer value

EditEventInviteeRequestDTO

宛先	タイプ	説明
fullName	string	The full name of the invitee.
phoneNumber	string	The phone number of the invitee.

EditEventRequestDTO

宛先	タイプ	説明
id	int	Event id. Ignore this field.
invitee	InviteeRequestDTO">EditEventInviteeRequestDTO	Invitee data
answers	EditEventAnswerRequestDTO[]	Answers

EventDTO

Event DTO

宛先	タイプ	説明
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
relatedEventIds	array	Array of related event IDs

EventEditNotesRequestDTO

Event edit notes request schema

宛先	タイプ	説明
notes	string	Notes.

EventInviteParticipantsRequestDTO

Event invite participants request schema

宛先	タイプ	説明
emails	array	Emails
message	string	Message

EventPaymentDTO

宛先	タイプ	説明
provider	string	provider
amount	number	amount
currency	string	currency
status	string	status
system	string	system
referenceId	int	referenceId
overwritePersonal	bool	overwritePersonal

EventTypeAvailabilityDTO

Event Type Availability

宛先	タイプ	説明
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 Hours

宛先	タイプ	説明
start	string	The start time of the availability hour
available	bool	Indicates if the hour is available

EventTypeDTO

Event type DTO

宛先	タイプ	説明
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

宛先	タイプ	説明
id	int	The unique identifier of the duration.
duration	int	Duration in minutes

EventTypeRequestLocationTypeDTO

宛先	タイプ	説明
id	int	The unique identifier
locationType	string	Location type: 'custom', 'zoom', 'request', 'whereby', 'google_meet', 'kopano_meet', 'microsoft_teams'

EventTypeTagDTO

Event Type Tag

宛先	タイプ	説明
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 Filter

宛先	タイプ	説明
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 Request

宛先	タイプ	説明
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 Request

宛先	タイプ	説明
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 Filter

宛先	タイプ	説明
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 Request

宛先	タイプ	説明
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

宛先	タイプ	説明
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 Interval

宛先	タイプ	説明
start	string	The start time of the interval.
end	string	The end time of the interval.

IntegrationListDTO

Integration list data transfer object

宛先	タイプ	説明
user	array	User integrations
organization	array	Organization integrations

InviteeDTO

Invitee

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
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 result

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
ids	array	Event ids

OrganizationDTO

宛先	タイプ	説明
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

Participant

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
email	string	Email

PollAvailabilityDTO

Data Transfer Object (DTO) for Poll Availability

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
date	string	The date for checking poll availability

PollDTO

Data Transfer Object (DTO) for Poll

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
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 Result

宛先	タイプ	説明
email	string	Email address of the client
comment	string	Comment of the client

PollResultRequestDTO

Poll result request schema

宛先	タイプ	説明
uuid	string	Poll UUID
availability	array	Availability ids
email	string	email
comment	string	comment

QuestionDTO

宛先	タイプ	説明
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 schema

宛先	タイプ	説明
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

Rescheduling

宛先	タイプ	説明
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

宛先	タイプ	説明
id	int	id
slug	string	slug
name	string	name
color	string	color
location_type	string	location_type
timezone	string	timezone
user_full_name	string	user_full_name
localized	bool	localized
direct_url	string	direct_url

SimpleUserDTO

宛先	タイプ	説明
id	int	id
email	string	email
fullName	string	fullName

SingleUseLinkDTO

Single use link response schema

宛先	タイプ	説明
code	string	The code of the single use link
url	string	The URL of the single use link

SocialLinkDTO

宛先	タイプ	説明
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

User

宛先	タイプ	説明
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 Tag

宛先	タイプ	説明
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 Request

宛先	タイプ	説明
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.

認証

HTTPリクエスト例:

ACL

Get list of ACL rules

エンドポイント:

方法:

戻る:

予約可能な時間枠の設定ルール

Save availability rule

エンドポイント:

方法:

リクエストパラメーター:

戻る:

キャンセルポリシー

Get organization cancellation policy

エンドポイント:

方法:

戻る:

Update organization cancellation policy

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Get user cancellation policy

エンドポイント:

方法:

戻る:

Update user cancellation policy

エンドポイント:

方法:

リクエストパラメーター:

戻る:

ミーティング

Cancel event

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Cancel event list

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Create event

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Get event

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Edit event

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Delete event

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Delete event list

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Edit event notes

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Invite participants to event

エンドポイント:

方法:

リクエストパラメーター:

戻る:

Get list of events

エンドポイント: