API Documentation 技術文件

取得授權

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

    Acl

  • Get list of ACL rules

    Returns list of ACL rules
    Endpoint:
    /panel/api/acl
    Method:
    get
    Return:

    • Availability rule

  • Save availability rule

    Saves the availability rule
    Endpoint:
    /panel/api/availability-rule
    Method:
    put
    Request parameters:
    AvailabilityRuleRequestDTO body - Availability rule data
    Return:
    Returns empty response when the operation is successful

    • Cancellation Policy

  • Get organization cancellation policy

    Returns the cancellation policy of the organization
    Endpoint:
    /panel/api/organization-cancellation-policy
    Method:
    get
    Return:

  • Update organization cancellation policy

    Updates the cancellation policy of the organization
    Endpoint:
    /panel/api/organization-cancellation-policy
    Method:
    put
    Request parameters:
    CancellationPolicyRequestDTO body - Cancellation policy data
    Return:

  • Get user cancellation policy

    Returns the cancellation policy of the user
    Endpoint:
    /panel/api/user-cancellation-policy
    Method:
    get
    Return:

  • Update user cancellation policy

    Updates the cancellation policy of the user
    Endpoint:
    /panel/api/user-cancellation-policy
    Method:
    put
    Request parameters:
    CancellationPolicyRequestDTO body - Cancellation policy data
    Return:

    • Meeting

  • Delete event list

    Delete event list by ids
    Endpoint:
    /panel/api/event/delete-list
    Method:
    delete
    Request parameters:
    DeleteEventListRequestDTO body - An array of integers representing the IDs of the events to be deleted
    Return:
    Returns empty response when the operation is successful

  • Cancel event list

    Cancel event list by ids
    Endpoint:
    /panel/api/event/cancel-list
    Method:
    put
    Request parameters:
    CancelEventListRequestDTO body - An object containing an array of event IDs to be cancelled and an optional reason for the cancellation
    Return:
    Returns empty response when the operation is successful

  • Create event

    Create event by request params
    Endpoint:
    /panel/api/event
    Method:
    post
    Request parameters:
    CreateEventRequestDTO body - An object containing the event details
    Return:

  • Get event

    Get event by id
    Endpoint:
    /panel/api/event/{id}
    Method:
    get
    Request parameters:
    int id - The id of the event
    Return:

  • Edit event

    Edit event by request params and ID
    Endpoint:
    /panel/api/event/{id}
    Method:
    put
    Request parameters:
    int id - The id of the event
    EditEventRequestDTO body - An object containing the event details
    Return:
    void

  • Delete event

    Delete event by id
    Endpoint:
    /panel/api/event/{id}
    Method:
    delete
    Request parameters:
    int id - The id of the event
    Return:
    Returns empty response when the operation is successful

  • Cancel event

    Cancel event by id
    Endpoint:
    /panel/api/event/cancel/{id}
    Method:
    put
    Request parameters:
    int id - The id of the event
    CancelEventRequestDTO body - An object containing the reason for the cancellation
    Return:
    Returns empty response when the operation is successful

  • Edit event notes

    Edit event notes by id
    Endpoint:
    /panel/api/event/notes/{id}
    Method:
    put
    Request parameters:
    int id - The id of the event
    EventEditNotesRequestDTO body - An object containing the notes for the event
    Return:
    Returns empty response when the operation is successful

  • Get list of events

    Get list of events by request params
    Endpoint:
    /panel/api/event/
    Method:
    get
    Request parameters:
    GetEventListRequestDTO query - An object containing the request parameters for fetching the list of events
    Return:
    {
    meta: MetaDataDTO
    items: EventDTO[]
    }

  • No show event

    No show event by id
    Endpoint:
    /panel/api/event/no-show/{id}
    Method:
    put
    Request parameters:
    int id - The id of the event
    Return:
    Returns empty response when the operation is successful

  • No show event list

    No show event list by ids
    Endpoint:
    /panel/api/event/no-show-list
    Method:
    put
    Request parameters:
    NoShowEventListRequestDTO body - An object containing an array of event IDs to be no-showed
    Return:
    Returns empty response when the operation is successful

  • Resend event notification

    Resend event notification by id
    Endpoint:
    /panel/api/event/resend-notification/{id}
    Method:
    put
    Request parameters:
    int id - The id of the event
    Return:
    Returns empty response when the operation is successful

  • Invite participants to event

    Invite participants to event by id
    Endpoint:
    /panel/api/event/invite-participants/{id}
    Method:
    post
    Request parameters:
    int id - The id of the event
    EventInviteParticipantsRequestDTO body - An object containing an array of participant emails and an optional message for the invitation
    Return:
    Returns empty response when the operation is successful

  • Reschedule event

    Reschedule event by id
    Endpoint:
    /panel/api/event/reschedule/{id}
    Method:
    put
    Request parameters:
    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
    Return:
    Returns empty response when the operation is successful

    • Meeting type

  • Get list of event types

    Get list of event types by request params
    Endpoint:
    /panel/api/event-type
    Method:
    get
    Request parameters:
    GetEventTypeListRequestDTO query - An object containing the request parameters for fetching the list of event types
    Return:

  • Get event type availability

    Get event type availability by request params
    Endpoint:
    /panel/api/event-type/availability/{id}
    Method:
    get
    Request parameters:
    int id - The id of the event type
    GetEventTypeAvailabilityRequestDTO query - An object containing the request parameters for fetching the availability of the event type
    Return:

  • Get event type

    Get event type by id
    Endpoint:
    /panel/api/event-type/{id}
    Method:
    get
    Request parameters:
    int id - The id of the event type
    Return:

    • Meeting type tag

  • Add event type tag to event type

    Add event type tag to event type description
    Endpoint:
    /panel/api/event-type-tag/{eventTypeId}/{tagId}
    Method:
    put
    Request parameters:
    int eventTypeId - The id of the event type
    int tagId - The id of the tag
    Return:
    Returns empty response when the operation is successful

  • Remove event type tag

    Remove event type tag by event type id and tag id
    Endpoint:
    /panel/api/event-type-tag/{eventTypeId}/{tagId}
    Method:
    delete
    Request parameters:
    int eventTypeId - The id of the event type
    int tagId - The id of the tag
    Return:
    Returns empty response when the operation is successful

  • Get event type tag list

    Get event type tag list by event type id
    Endpoint:
    /panel/api/event-type-tag/{eventTypeId}
    Method:
    get
    Request parameters:
    int eventTypeId - The id of the event type
    Return:

    • Integration

  • Get list of integrations

    Returns list of integrations
    Endpoint:
    /panel/api/integration
    Method:
    get
    Return:

    • Poll

  • Retrieve a poll by ID

    Retrieves a poll based on the provided ID
    Endpoint:
    /panel/api/poll/{id}
    Method:
    get
    Request parameters:
    int id - ID of the poll
    Return:

  • Delete a poll

    Delete a poll by ID
    Endpoint:
    /panel/api/poll/{id}
    Method:
    delete
    Request parameters:
    int id - ID of the poll
    Return:
    Returns empty response when the operation is successful

  • Create a poll result

    Create a poll result with the provided request data
    Endpoint:
    /panel/api/poll/poll-result
    Method:
    post
    Request parameters:
    PollResultRequestDTO body - The request data for creating a poll result
    Return:
    Returns empty response when the operation is successful

  • Create a new poll

    Create a new poll with the provided request data
    Endpoint:
    /panel/api/poll
    Method:
    post
    Request parameters:
    PollRequestDTO body - The request data for creating a new poll
    Return:

  • Get list of polls

    Get list of polls by request params
    Endpoint:
    /panel/api/poll
    Method:
    get
    Request parameters:
    GetPollListRequestDTO request - The request parameters for fetching the list of polls
    Return:

    • Single use link

  • Create a single use link

    Create a single use link for an event type
    Endpoint:
    /panel/api/single-use-link/{id}
    Method:
    post
    Request parameters:
    int id - ID of the event type
    Return:

    • User

  • Get current user

    Returns the current user
    Endpoint:
    /panel/api/current-user
    Method:
    get
    Return:

  • Get user list

    Returns the list of users
    Endpoint:
    /panel/api/user
    Method:
    get
    Return:

    • User meeting type tag

  • Get user event type tag list

    Returns the list of user event type tags
    Endpoint:
    /panel/api/user-event-type-tag
    Method:
    get
    Return:

  • Create user event type tag

    Creates a new user event type tag
    Endpoint:
    /panel/api/user-event-type-tag
    Method:
    post
    Request parameters:
    UserEventTypeTagRequestDTO body - User event type tag data
    Return:

  • Update user event type tag

    Updates the specified user event type tag
    Endpoint:
    /panel/api/user-event-type-tag/{id}
    Method:
    put
    Request parameters:
    int id - The ID of the user event type tag to update
    UserEventTypeTagRequestDTO body - User event type tag data
    Return:

  • Delete user event type tag

    Deletes the specified user event type tag
    Endpoint:
    /panel/api/user-event-type-tag/{id}
    Method:
    delete
    Request parameters:
    int id - The ID of the user event type tag to delete
    Return:
    Successful operation

    Types

  • AclRuleDTO

    Access Control List Rule schema
    Name Type Description
    resource string Resource name
    attributes array Resource attributes
    allowedAttributes array Allowed attributes for current user

  • AnswerDTO

    Answer
    Name 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 schema
    Name Type Description
    value string Answer value
    question string Question UUID

  • AvailabilityRuleDTO

    Availability Rule
    Name 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 Request
    Name 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 schema
    Name Type Description
    ids array Event ids
    reason string Reason of cancellation.

  • CancelEventRequestDTO

    Cancel event request schema
    Name Type Description
    reason string Reason of cancellation.

  • CancellationDTO

    Cancellation
    Name 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 object
    Name 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 DTO
    Name 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 schema
    Name 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 schema
    Name Type Description
    ids array Event ids

  • EditEventAnswerRequestDTO

    EditEventAnswerRequestDTO
    Name Type Description
    id int Answer id.
    value string Answer value

  • EditEventInviteeRequestDTO

    EditEventInviteeRequestDTO
    Name Type Description
    fullName string The full name of the invitee.
    phoneNumber string The phone number of the invitee.

  • EditEventRequestDTO

    EditEventRequestDTO
    Name Type Description
    id int Event id. Ignore this field.
    invitee InviteeRequestDTO">EditEventInviteeRequestDTO Invitee data
    answers EditEventAnswerRequestDTO[] Answers

  • EventDTO

    Event DTO
    Name 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
    relatedEventIds array Array of related event IDs

  • EventEditNotesRequestDTO

    Event edit notes request schema
    Name Type Description
    notes string Notes.

  • EventInviteParticipantsRequestDTO

    Event invite participants request schema
    Name Type Description
    emails array Emails
    message string Message

  • EventPaymentDTO

    EventPaymentDTO
    Name 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 Availability
    Name 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 Hours
    Name Type Description
    start string The start time of the availability hour
    available bool Indicates if the hour is available

  • EventTypeDTO

    Event type DTO
    Name 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

    EventTypeDurationDTO
    Name Type Description
    id int The unique identifier of the duration.
    duration int Duration in minutes

  • EventTypeRequestLocationTypeDTO

    EventTypeRequestLocationTypeDTO
    Name Type Description
    id int The unique identifier
    locationType string Location type: 'custom', 'zoom', 'request', 'whereby', 'google_meet', 'kopano_meet', 'microsoft_teams'

  • EventTypeTagDTO

    Event Type Tag
    Name 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 Filter
    Name 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 Request
    Name 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 Request
    Name 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 Filter
    Name 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 Request
    Name 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

    GetPollListRequestDTO
    Name 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 Interval
    Name Type Description
    start string The start time of the interval.
    end string The end time of the interval.

  • IntegrationListDTO

    Integration list data transfer object
    Name Type Description
    user array User integrations
    organization array Organization integrations

  • InviteeDTO

    Invitee
    Name 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 schema
    Name 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 result
    Name 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 schema
    Name Type Description
    ids array Event ids

  • OrganizationDTO

    OrganizationDTO
    Name 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

    Participant
    Name 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 schema
    Name Type Description
    email string Email

  • PollAvailabilityDTO

    Data Transfer Object (DTO) for Poll Availability
    Name 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 schema
    Name Type Description
    date string The date for checking poll availability

  • PollDTO

    Data Transfer Object (DTO) for Poll
    Name 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 schema
    Name 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 Result
    Name Type Description
    email string Email address of the client
    comment string Comment of the client

  • PollResultRequestDTO

    Poll result request schema
    Name Type Description
    uuid string Poll UUID
    availability array Availability ids
    email string email
    comment string comment

  • QuestionDTO

    QuestionDTO
    Name 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 schema
    Name 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

    Rescheduling
    Name 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

    SimpleEventTypeDTO
    Name Type Description
    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

    SimpleUserDTO
    Name Type Description
    id int id
    email string email
    fullName string fullName

  • SingleUseLinkDTO

    Single use link response schema
    Name Type Description
    code string The code of the single use link
    url string The URL of the single use link

  • SocialLinkDTO

    SocialLinkDTO
    Name 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

    User
    Name 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 Tag
    Name 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 Request
    Name 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.