Unified.to event API

openapi: 3.0.0
info:
  contact:
    email: hello@unified.to
    url: https://unified.to/contact
  description: One API to Rule Them All
  termsOfService: https://unified.to/tos
  title: Unified.to account event API
  version: '1.0'
servers:
- description: North American data region
  url: https://api.unified.to
- description: European data region
  url: https://api-eu.unified.to
- description: Australian data region
  url: https://api-au.unified.to
security:
- jwt: []
tags:
- name: event
paths:
  /crm/{connection_id}/event:
    get:
      operationId: listCrmEvents
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: number
      - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: updated_gte
        required: false
        schema:
          type: string
      - in: query
        name: sort
        required: false
        schema:
          type: string
      - in: query
        name: order
        required: false
        schema:
          type: string
      - description: Query string to search. eg. email address or name
        in: query
        name: query
        required: false
        schema:
          type: string
      - description: The deal ID to filter by (reference to CrmDeal)
        in: query
        name: deal_id
        required: false
        schema:
          type: string
      - description: The contact ID to filter by (reference to CrmContact)
        in: query
        name: contact_id
        required: false
        schema:
          type: string
      - description: The company ID to filter by (reference to CrmCompany)
        in: query
        name: company_id
        required: false
        schema:
          type: string
      - description: The user/employee ID to filter by (reference to HrisEmployee)
        in: query
        name: user_id
        required: false
        schema:
          type: string
      - in: query
        name: type
        required: false
        schema:
          type: string
      - description: The CRM lead ID to filter by (reference to CrmLead)
        in: query
        name: lead_id
        required: false
        schema:
          type: string
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - type
            - note
            - meeting
            - email
            - call
            - task
            - marketing_email
            - form
            - page_view
            - deal_ids
            - company_ids
            - contact_ids
            - lead_ids
            - user_id
            - raw
            type: string
          type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmEvents'
          description: Successful
      security:
      - jwt: []
      summary: List all events
      tags:
      - event
    post:
      operationId: createCrmEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - type
            - note
            - meeting
            - email
            - call
            - task
            - marketing_email
            - form
            - page_view
            - deal_ids
            - company_ids
            - contact_ids
            - lead_ids
            - user_id
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmEvent'
        description: An event represents an event, activity, or engagement and is always associated with a deal, contact, or company
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmEvent'
          description: Successful
      security:
      - jwt: []
      summary: Create an event
      tags:
      - event
  /crm/{connection_id}/event/{id}:
    delete:
      operationId: removeCrmEvent
      parameters:
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful
        default:
          content: {}
          description: Successful
          headers:
            Content-Type:
              required: false
              schema:
                type: string
      security:
      - jwt: []
      summary: Remove an event
      tags:
      - event
    get:
      operationId: getCrmEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - type
            - note
            - meeting
            - email
            - call
            - task
            - marketing_email
            - form
            - page_view
            - deal_ids
            - company_ids
            - contact_ids
            - lead_ids
            - user_id
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmEvent'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve an event
      tags:
      - event
    patch:
      operationId: patchCrmEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - type
            - note
            - meeting
            - email
            - call
            - task
            - marketing_email
            - form
            - page_view
            - deal_ids
            - company_ids
            - contact_ids
            - lead_ids
            - user_id
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmEvent'
        description: An event represents an event, activity, or engagement and is always associated with a deal, contact, or company
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmEvent'
          description: Successful
      security:
      - jwt: []
      summary: Update an event
      tags:
      - event
    put:
      operationId: updateCrmEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - type
            - note
            - meeting
            - email
            - call
            - task
            - marketing_email
            - form
            - page_view
            - deal_ids
            - company_ids
            - contact_ids
            - lead_ids
            - user_id
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmEvent'
        description: An event represents an event, activity, or engagement and is always associated with a deal, contact, or company
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmEvent'
          description: Successful
      security:
      - jwt: []
      summary: Update an event
      tags:
      - event
  /calendar/{connection_id}/event:
    get:
      operationId: listCalendarEvents
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: number
      - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: updated_gte
        required: false
        schema:
          type: string
      - in: query
        name: sort
        required: false
        schema:
          type: string
      - in: query
        name: order
        required: false
        schema:
          type: string
      - description: Query string to search. eg. email address or name
        in: query
        name: query
        required: false
        schema:
          type: string
      - description: The calendar ID to filter by (reference to CalendarCalendar)
        in: query
        name: calendar_id
        required: false
        schema:
          type: string
      - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: start_gte
        required: false
        schema:
          type: string
      - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: end_lt
        required: false
        schema:
          type: string
      - description: Whether to flatten grouped or recurring items into individual entries.
        in: query
        name: expand
        required: false
        schema:
          type: boolean
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - calendar_id
            - subject
            - start_at
            - end_at
            - is_all_day
            - timezone
            - notes
            - location
            - is_free
            - is_private
            - status
            - organizer
            - attendees
            - recurring_event_id
            - recurrence
            - web_url
            - has_conference
            - conference
            - attachments
            - send_notifications
            - raw
            type: string
          type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEvents'
          description: Successful
      security:
      - jwt: []
      summary: List All Events
      tags:
      - event
    post:
      operationId: createCalendarEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - calendar_id
            - subject
            - start_at
            - end_at
            - is_all_day
            - timezone
            - notes
            - location
            - is_free
            - is_private
            - status
            - organizer
            - attendees
            - recurring_event_id
            - recurrence
            - web_url
            - has_conference
            - conference
            - attachments
            - send_notifications
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarEvent'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEvent'
          description: Successful
      security:
      - jwt: []
      summary: Create an Event
      tags:
      - event
  /calendar/{connection_id}/event/{id}:
    delete:
      operationId: removeCalendarEvent
      parameters:
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful
        default:
          content: {}
          description: Successful
          headers:
            Content-Type:
              required: false
              schema:
                type: string
      security:
      - jwt: []
      summary: Remove an Event
      tags:
      - event
    get:
      operationId: getCalendarEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - calendar_id
            - subject
            - start_at
            - end_at
            - is_all_day
            - timezone
            - notes
            - location
            - is_free
            - is_private
            - status
            - organizer
            - attendees
            - recurring_event_id
            - recurrence
            - web_url
            - has_conference
            - conference
            - attachments
            - send_notifications
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEvent'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve an Event
      tags:
      - event
    patch:
      operationId: patchCalendarEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - calendar_id
            - subject
            - start_at
            - end_at
            - is_all_day
            - timezone
            - notes
            - location
            - is_free
            - is_private
            - status
            - organizer
            - attendees
            - recurring_event_id
            - recurrence
            - web_url
            - has_conference
            - conference
            - attachments
            - send_notifications
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarEvent'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEvent'
          description: Successful
      security:
      - jwt: []
      summary: Update an Event
      tags:
      - event
    put:
      operationId: updateCalendarEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - calendar_id
            - subject
            - start_at
            - end_at
            - is_all_day
            - timezone
            - notes
            - location
            - is_free
            - is_private
            - status
            - organizer
            - attendees
            - recurring_event_id
            - recurrence
            - web_url
            - has_conference
            - conference
            - attachments
            - send_notifications
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarEvent'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEvent'
          description: Successful
      security:
      - jwt: []
      summary: Update an Event
      tags:
      - event
  /messaging/{connection_id}/event/{id}:
    patch:
      operationId: patchMessagingEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - type
            - channel
            - message
            - button
            - user
            - raw
            - is_replacing_original
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessagingEvent'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingEvent'
          description: Successful
      security:
      - jwt: []
      summary: Update an Event
      tags:
      - event
    put:
      operationId: updateMessagingEvent
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - type
            - channel
            - message
            - button
            - user
            - raw
            - is_replacing_original
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Event
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessagingEvent'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagingEvent'
          description: Successful
      security:
      - jwt: []
      summary: Update an Event
      tags:
      - event
components:
  schemas:
    property_CrmEvent_company_ids:
      description: An array of company IDs associated with this event
      items:
        type: string
      type: array
    property_CalendarEventRecurrence_included_dates:
      description: dates to include in the recurrence, defaults to undefined (no inclusions)
      items:
        type: string
      type: array
    property_CrmEvent_email_attachment_file_ids:
      items:
        type: string
      type: array
    property_CrmEvent_marketing_email_attachment_file_ids:
      items:
        type: string
      type: array
    CrmEvent:
      description: An event represents an event, activity, or engagement and is always associated with a deal, contact, or company
      properties:
        call:
          $ref: '#/components/schemas/property_CrmEvent_call'
        company_ids:
          $ref: '#/components/schemas/property_CrmEvent_company_ids'
        contact_ids:
          $ref: '#/components/schemas/property_CrmEvent_contact_ids'
        created_at:
          format: date-time
          type: string
        deal_ids:
          $ref: '#/components/schemas/property_CrmEvent_deal_ids'
        email:
          $ref: '#/components/schemas/property_CrmEvent_email'
        form:
          $ref: '#/components/schemas/property_CrmEvent_form'
        id:
          type: string
        lead_ids:
          $ref: '#/components/schemas/property_CrmEvent_lead_ids'
        marketing_email:
          $ref: '#/components/schemas/property_CrmEvent_marketing_email'
        meeting:
          $ref: '#/components/schemas/property_CrmEvent_meeting'
        note:
          $ref: '#/components/schemas/property_CrmEvent_note'
        page_view:
          $ref: '#/components/schemas/property_CrmEvent_page_view'
        raw:
          additionalProperties: true
          type: object
        task:
          $ref: '#/components/schemas/property_CrmEvent_task'
        type:
          enum:
          - NOTE
          - EMAIL
          - TASK
          - MEETING
          - CALL
          - MARKETING_EMAIL
          - FORM
          - PAGE_VIEW
          type: string
          x-speakeasy-unknown-values: allow
        updated_at:
          format: date-time
          type: string
        user_id:
          type: string
      type: object
    property_CrmEvent_email_cc:
      description: The event email's cc name & email (name <test@test.com>)
      items:
        type: string
      type: array
    property_MessagingEvent_message:
      properties:
        attachments:
          $ref: '#/components/schemas/property_MessagingEvent_message_attachments'
        author_member:
          $ref: '#/components/schemas/property_MessagingEvent_message_author_member'
        buttons:
          $ref: '#/components/schemas/property_MessagingEvent_message_buttons'
        channel_id:
          type: string
        channel_ids:
          $ref: '#/components/schemas/property_MessagingEvent_message_channel_ids'
        channels:
          $ref: '#/components/schemas/property_MessagingEvent_message_channels'
        created_at:
          format: date-time
          type: string
        destination_members:
          $ref: '#/components/schemas/property_MessagingEvent_message_destination_members'
        has_children:
          type: boolean
        hidden_members:
          $ref: '#/components/schemas/property_MessagingEvent_message_hidden_members'
        id:
          type: string
        is_unread:
          type: boolean
        mentioned_members:
          $ref: '#/components/schemas/property_MessagingEvent_message_mentioned_members'
        message:
          type: string
        message_html:
          type: string
        message_markdown:
          type: string
        message_thread_identifier:
          type: string
        parent_id:
          type: string
        raw:
          additionalProperties: true
          type: object
        reactions:
          $ref: '#/components/schemas/property_MessagingEvent_message_reactions'
        reference:
          type: string
        root_message_id:
          type: string
        subject:
          type: string
        updated_at:
          format: date-time
          type: string
        web_url:
          type: string
      type: object
    property_CrmEvent_form:
      properties:
        archived_at:
          format: date-time
          type: string
        fields:
          $ref: '#/components/schemas/property_CrmEvent_form_fields'
        name:
          type: string
        redirect_url:
          type: string
      type: object
    property_CalendarEvent_attendees:
      items:
        $ref: '#/components/schemas/CalendarAttendee'
      type: array
    property_MessagingEvent_user:
      properties:
        id:
          type: string
        name:
          type: string
      type: object
    property_MessagingEvent_message_channels:
      description: Represents the names of all channels to which the message is sent. Identifies the channels where the message is posted.
      items:
        $ref: '#/components/schemas/MessagingReference'
      type: array
    CalendarConference:
      properties:
        conference_identifier:
          type: string
        country_code:
          type: string
        host_access_code:
          type: string
        label:
          type: string
        notes:
          type: string
        participant_access_code:
          type: string
        region_code:
          type: string
        telephone:
          type: string
        url:
          type: string
      type: object
    property_CrmEvent_form_fields:
      items:
        $ref: '#/components/schemas/CrmEventFormField'
      type: array
    MessagingEvent:
      properties:
        button:
          $ref: '#/components/schemas/property_MessagingEvent_button'
        channel:
          $ref: '#/components/schemas/property_MessagingEvent_channel'
        created_at:
          format: date-time
          type: string
        id:
          type: string
        is_replacing_original:
          type: boolean
        message:
          $ref: '#/components/schemas/property_MessagingEvent_message'
        raw:
          additionalProperties: true
          type: object
        type:
          enum:
          - MESSAGE_RECEIVED
          - REACTION_ADDED
          - REACTION_REMOVED
          - BUTTON_CLICK
          - APP_MENTION
          - CHANNEL_JOINED
          - CHANNEL_LEFT
          - CHANNEL_CREATED
          - CHANNEL_DELETED
          - CHANNEL_RENAMED
          - USER_CREATED
          - USER_DELETED
          - USER_UPDATED
          type: string
          x-speakeasy-unknown-values: allow
        user:
          $ref: '#/components/schemas/property_MessagingEvent_user'
      type: object
    property_CrmEvent_call:
      description: The call object, when type = call
      properties:
        description:
          type: string
        duration:
          type: number
        start_at:
          format: date-time
          type: string
      type: object
    property_CalendarEventRecurrence_on_weeks:
      description: week ordinals for BYDAY (e.g., -1 for last, -2 for second-to-last, 1 for first, 2 for second), only used with on_days. 0 is used for days without week ordinals.
      items:
        type: number
      type: array
    property_CalendarEvent_organizer:
      properties:
        email:
          type: string
        is_cohost:
          type: boolean
        name:
          type:

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/openapi/unified-to-event-api-openapi.yml