Unified.to unified 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: .to account unified 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: unified
paths:
  /unified/apicall:
    get:
      operationId: listUnifiedApicalls
      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: Filter the results to only those integrations for your user referenced by this value
        in: query
        name: external_xref
        required: false
        schema:
          type: string
      - description: Filter the results to just this integration
        in: query
        name: integration_type
        required: false
        schema:
          type: string
      - description: Filter the results for API Calls with errors
        in: query
        name: error
        required: false
        schema:
          type: boolean
      - description: Filter the results to just this integration
        in: query
        name: connection_id
        required: false
        schema:
          type: string
      - in: query
        name: env
        required: false
        schema:
          type: string
      - description: Filter the results to just this webhook
        in: query
        name: webhook_id
        required: false
        schema:
          type: string
      - description: Filter the results to just this type
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Filter the results for only billable API Calls
        in: query
        name: is_billable
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCalls'
          description: Successful
      security:
      - jwt: []
      summary: Returns Api Calls
      tags:
      - unified
  /unified/apicall/{id}:
    get:
      operationId: getUnifiedApicall
      parameters:
      - description: ID of the Apicall
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCall'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve Specific Api Call by Its Id
      tags:
      - unified
  /unified/connection:
    get:
      operationId: listUnifiedConnections
      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: Filter the results to only those integrations for your user referenced by this value
        in: query
        name: external_xref
        required: false
        schema:
          type: string
      - description: Filter the results on these categories
        in: query
        name: categories
        required: false
        schema:
          items:
            enum:
            - passthrough
            - hris
            - ats
            - auth
            - crm
            - enrich
            - martech
            - ticketing
            - uc
            - accounting
            - storage
            - commerce
            - payment
            - genai
            - messaging
            - kms
            - task
            - scim
            - lms
            - repo
            - metadata
            - calendar
            - verification
            - ads
            - forms
            - shipping
            - assessment
            - signing
            type: string
          type: array
      - in: query
        name: env
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connections'
          description: Successful
      security:
      - jwt: []
      summary: List All Connections
      tags:
      - unified
    post:
      description: Used only to import existing customer credentials; use "Authorize new connection" instead
      operationId: createUnifiedConnection
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Connection'
        description: A connection represents a specific authentication of an integration.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
          description: Successful
      security:
      - jwt: []
      summary: Create Connection
      tags:
      - unified
  /unified/connection/{id}:
    delete:
      operationId: removeUnifiedConnection
      parameters:
      - description: ID of the Connection
        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 Connection
      tags:
      - unified
    get:
      operationId: getUnifiedConnection
      parameters:
      - description: ID of the Connection
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve Connection
      tags:
      - unified
    patch:
      operationId: patchUnifiedConnection
      parameters:
      - description: ID of the Connection
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Connection'
        description: A connection represents a specific authentication of an integration.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
          description: Successful
      security:
      - jwt: []
      summary: Update Connection
      tags:
      - unified
    put:
      operationId: updateUnifiedConnection
      parameters:
      - description: ID of the Connection
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Connection'
        description: A connection represents a specific authentication of an integration.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
          description: Successful
      security:
      - jwt: []
      summary: Update Connection
      tags:
      - unified
  /unified/environment:
    get:
      operationId: listUnifiedEnvironments
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environments'
          description: Successful
      security:
      - jwt: []
      summary: Returns All Environments
      tags:
      - unified
    post:
      operationId: createUnifiedEnvironment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Environments'
        description: A list of environments in the workspace.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environments'
          description: Successful
      security:
      - jwt: []
      summary: Create New Environments
      tags:
      - unified
  /unified/environment/{env}:
    delete:
      operationId: removeUnifiedEnvironment
      parameters:
      - in: path
        name: env
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environments'
          description: Successful
      security:
      - jwt: []
      summary: Remove an Environment
      tags:
      - unified
  /unified/integration:
    get:
      operationId: listUnifiedIntegrations
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: number
      - in: query
        name: updated_gte
        required: false
        schema:
          type: string
      - description: Filter the results on these categories
        in: query
        name: categories
        required: false
        schema:
          items:
            enum:
            - passthrough
            - hris
            - ats
            - auth
            - crm
            - enrich
            - martech
            - ticketing
            - uc
            - accounting
            - storage
            - commerce
            - payment
            - genai
            - messaging
            - kms
            - task
            - scim
            - lms
            - repo
            - metadata
            - calendar
            - verification
            - ads
            - forms
            - shipping
            - assessment
            - signing
            type: string
          type: array
      - in: query
        name: summary
        required: false
        schema:
          type: boolean
      - description: Filter the results for only the workspace's active integrations
        in: query
        name: active
        required: false
        schema:
          type: boolean
      - in: query
        name: env
        required: false
        schema:
          type: string
      - description: Filter the results for only this integration type
        in: query
        name: type
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integrations'
          description: Successful
      security:
      - jwt: []
      summary: Returns All Integrations
      tags:
      - unified
  /unified/integration/auth/{workspace_id}/{integration_type}:
    get:
      description: Returns an authorization URL for the specified integration.  Once a successful authorization occurs, a new connection is created.
      operationId: getUnifiedIntegrationAuth
      parameters:
      - description: The URL where you want the user to be redirect to after a successful authorization.  The connection ID will be appended with (id=<connectionId>) to this URL, as will the state that was provided.
        in: query
        name: success_redirect
        required: false
        schema:
          type: string
      - description: The URL where you want the user to be redirect to after an unsuccessful authentication. An "error" variable will be appended.
        in: query
        name: failure_redirect
        required: false
        schema:
          type: string
      - description: Extra state to send back to your success URL
        in: query
        name: state
        required: false
        schema:
          type: string
      - description: Your user identifier to associate with the new Integration
        in: query
        name: external_xref
        required: false
        schema:
          type: string
      - in: query
        name: scopes
        required: false
        schema:
          items:
            type: string
          type: array
      - in: query
        name: redirect
        required: false
        schema:
          type: boolean
      - in: query
        name: env
        required: false
        schema:
          type: string
      - description: 'Language: en, fr, es, it, pt, zh, hi'
        in: query
        name: lang
        required: false
        schema:
          type: string
      - description: Optional tenant domain or subdomain for integrations that require it to build the authorize, token, or API URL. Depending on the integration, this may be a bare subdomain or a full domain/URL.
        in: query
        name: subdomain
        required: false
        schema:
          type: string
      - description: The ID of the workspace
        in: path
        name: workspace_id
        required: true
        schema:
          type: string
      - description: Type of the supported integration
        in: path
        name: integration_type
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            text/plain:
              schema:
                type: string
          description: Successful
      summary: Authorize New Connection
      tags:
      - unified
  /unified/integration/workspace/{workspace_id}:
    get:
      description: No authentication required as this is to be used by front-end interface
      operationId: listUnifiedIntegrationWorkspaces
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: number
      - in: query
        name: updated_gte
        required: false
        schema:
          type: string
      - description: Filter the results on these categories
        in: query
        name: categories
        required: false
        schema:
          items:
            enum:
            - passthrough
            - hris
            - ats
            - auth
            - crm
            - enrich
            - martech
            - ticketing
            - uc
            - accounting
            - storage
            - commerce
            - payment
            - genai
            - messaging
            - kms
            - task
            - scim
            - lms
            - repo
            - metadata
            - calendar
            - verification
            - ads
            - forms
            - shipping
            - assessment
            - signing
            type: string
          type: array
      - in: query
        name: summary
        required: false
        schema:
          type: boolean
      - description: Filter the results for only the workspace's active integrations
        in: query
        name: active
        required: false
        schema:
          type: boolean
      - in: query
        name: env
        required: false
        schema:
          type: string
      - description: The ID of the workspace
        in: path
        name: workspace_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integrations'
          description: Successful
      summary: Returns All Activated Integrations in a Workspace
      tags:
      - unified
  /unified/issue:
    get:
      operationId: listUnifiedIssues
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Issues'
          description: Successful
      security:
      - jwt: []
      summary: List Support Issues
      tags:
      - unified
  /unified/issue/{id}:
    get:
      operationId: getUnifiedIssue
      parameters:
      - description: ID of the Issue
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Issue'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve Support Issue
      tags:
      - unified
  /unified/webhook:
    get:
      operationId: listUnifiedWebhooks
      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: Filter the results for webhooks for only this object
        in: query
        name: object
        required: false
        schema:
          type: string
      - description: Filter the results to just this integration
        in: query
        name: integration_type
        required: false
        schema:
          type: string
      - description: Filter the results to just this integration
        in: query
        name: connection_id
        required: false
        schema:
          type: string
      - description: Return only results whose created date is equal or less to this value
        in: query
        name: created_lte
        required: false
        schema:
          type: string
      - in: query
        name: env
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhooks'
          description: Successful
      security:
      - jwt: []
      summary: Returns All Registered Webhooks
      tags:
      - unified
    post:
      description: The data payload received by your server is described at https://docs.unified.to/unified/overview. The `interval` field can be set as low as 1 minute for paid accounts, and 60 minutes for free accounts.
      operationId: createUnifiedWebhook
      parameters:
      - description: When set, all of the existing data will sent back to your server.
        in: query
        name: include_all
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Webhook'
        description: A webhook is used to POST new/updated information to your server.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: Successful
      security:
      - jwt: []
      summary: Create Webhook Subscription
      tags:
      - unified
  /unified/webhook/{id}:
    delete:
      operationId: removeUnifiedWebhook
      parameters:
      - description: ID of the Webhook
        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 Webhook Subscription
      tags:
      - unified
    get:
      operationId: getUnifiedWebhook
      parameters:
      - description: ID of the Webhook
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve Webhook by Its Id
      tags:
      - unified
    patch:
      operationId: patchUnifiedWebhook
      parameters:
      - description: ID of the Webhook
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Webhook'
        description: A webhook is used to POST new/updated information to your server.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: Successful
      security:
      - jwt: []
      summary: Update Webhook Subscription
      tags:
      - unified
    put:
      operationId: updateUnifiedWebhook
      parameters:
      - description: ID of the Webhook
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Webhook'
        description: A webhook is used to POST new/updated information to your server.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: Successful
      security:
      - jwt: []
      summary: Update Webhook Subscription
      tags:
      - unified
  /unified/webhook/{id}/trigger:
    patch:
      operationId: patchUnifiedWebhookTrigger
      parameters:
      - description: ID of the Webhook
        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: Trigger Webhook
      tags:
      - unified
    put:
      operationId: updateUnifiedWebhookTrigger
      parameters:
      - description: ID of the Webhook
        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: Trigger Webhook
      tags:
      - unified
components:
  schemas:
    property_IntegrationSupport_slow_fields:
      items:
        type: string
      type: array
    Webhook:
      description: A webhook is used to POST new/updated information to your server.
      properties:
        checked_at:
          format: date-time
          type: string
        connection_id:
          type: string
        created_at:
          format: date-time
          type: string
        db_name_prefix:
          type: string
        db_schema:
          type: string
        db_type:
          enum:
          - mongodb
          - mysql
          - postgres
          - mssql
          - mariadb
          - supabase
          type: string
          x-speakeasy-unknown-values: allow
        db_url:
          type: string
        environment:
          default: Production
          type: string
        event:
          enum:
          - updated
          - created
          - deleted
          type: string
          x-speakeasy-unknown-values: allow
        fields:
          type: string
        filters:
          $ref: '#/components/schemas/property_Webhook_filters'
        hook_url:
          type: string
        id:
          type: string
        integration_type:
          type: string
        interval:
          type: number
        is_beta:
          type: boolean
        is_healthy:
          type: boolean
        is_paused:
          type: boolean
        object_type:
          enum:
          - accounting_account
          - accounting_transaction
          - accounting_journal
          - accounting_contact
          - accounting_invoice
          - accounting_bill
          - accounting_creditmemo
          - accounting_taxrate
          - accounting_organization
          - accounting_order
          - accounting_salesorder
          - accounting_purchaseorder
          - accounting_report
          - accounting_balancesheet
          - accounting_profitloss
          - accounting_trialbalance
          - accounting_category
          - accounting_expense
          - accounting_cashflow
          - payment_payment
          - payment_link
          - payment_payout
          - payment_refund
          - payment_subscription
          - commerce_item
          - commerce_collection
          - commerce_inventory
          - commerce_location
          - commerce_review
          - commerce_saleschannel
          - commerce_itemvariant
          - commerce_reservation
          - commerce_availability
          - verification_package
          - verification_request
          - assessment_package
          - assessment_order
          - ats_activity
          - ats_application
          - ats_applicationstatus
          - ats_candidate
          - ats_document
          - ats_interview
          - ats_job
          - ats_scorecard
          - ats_company
          - crm_company
          - crm_contact
          - crm_deal
          - crm_event
          - crm_lead
          - crm_pipeline
          - hris_employee
          - hris_group
          - hris_payslip
          - hris_timeoff
          - hris_company
          - hris_location
          - hris_device
          - hris_timeshift
          - hris_deduction
          - hris_benefit
          - hris_bankaccount
          - martech_list
          - martech_member
          - martech_campaign
          - martech_report
          - passthrough
          - ticketing_note
          - ticketing_ticket
          - ticketing_customer
          - ticketing_category
          - uc_contact
          - uc_call
          - uc_comment
          - uc_recording
          - enrich_person
          - enrich_company
          - storage_file
          - genai_model
          - genai_prompt
          - genai_embedding
          - messaging_message
          - messaging_channel
          - messaging_event
          - kms_space
          - kms_page
          - kms_comment
          - task_project
          - task_task
          - task_comment
          - task_change
          - scim_users
          - scim_groups
          - lms_course
          - lms_class
          - lms_student
          - lms_instructor
          - lms_content
          - lms_collection
          - lms_activity
          - repo_organization
          - repo_repository
          - repo_branch
          - repo_commit
          - repo_pullrequest
          - metadata_metadata
          - calendar_calendar
          - calendar_event
          - calendar_busy
          - calendar_link
          - calendar_recording
          - calendar_webinar
          - ads_organization
          - ads_ad
          - ads_campaign
          - ads_report
          - ads_group
          - ads_creative
          - ads_insertionorder
          - ads_target
          - ads_promoted
          - forms_form
          - forms_submission
          - shipping_carrier
          - shipping_rate
          - shipping_shipment
          - shipping_label
          - shipping_tracking
          - signing_document
          - signing_signatory
          - signing_template
          type: string
          x-speakeasy-unknown-values: allow
        page_max_limit:
          type: number
        runs:
          $ref: '#/components/schemas/property_Webhook_runs'
        updated_at:
          format: date-time
          type: string
        webhook_type:
          enum:
          - virtual
          - native
          type: string
          x-speakeasy-unknown-values: allow
        workspace_id:
          type: string
      required:
      - connection_id
      - object_type
      - event
      type: object
    property_IntegrationSupport_webhook_events:
      properties:
        created:
          $ref: '#/components/schemas/property_IntegrationSupport_webhook_events_created'
        deleted:
          $ref: '#/components/schemas/property_IntegrationSupport_webhook_events_deleted'
        updated:
          $ref: '#/components/schemas/property_IntegrationSupport_webhook_events_updated'
      type: object
    property_IntegrationSupport_webhook_events_deleted:
      items:
        enum:
        - virtual
        - native
        type: string
        x-speakeasy-unknown-values: allow
      type: array
    property_IntegrationSupport_inbound_fields:
      additionalProperties:
        type: string
      type: object
    property_IntegrationSupport_methods:
      additionalProperties:
        type: boolean
      type: object
    property_IntegrationSupport_raw_objects:
      description: objects that we map from in the integration
      items:
        type: string
      type: array
    property_IntegrationSupport_webhook_events_created:
      items:
        enum:
        - virtual
        - native
        type: string
        x-speakeasy-unknown-values: allow
      type: array
    property_IntegrationSupport_outbound_fields:
      additionalProperties:
        type: string
      type: object
    Webhooks:
      items:
        $ref: '#/components/schemas/Webhook'
      type: array
    property_Issue_type:
      items:
        type: string
      type: array
    property_Connection_permissions:
      items:
        enum:
        - accounting_account_read
        - accounting_account_write
        - accounting_transaction_read
        - accounting_transaction_write
        - accounting_journal_read
        - accounting_journal_write
        - accounting_invoice_read
        - accounting_invoice_write
        - accounting_bill_read
   

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