Unify

Unify Sequences API

List, retrieve, pause, resume and delete Unify outbound sequences and read their ordered steps. 7 operation(s).

GitHub OpenAPI

Operations 7

GET /sequences/v1/sequences #
GET /sequences/v1/sequences/{id} #
DELETE /sequences/v1/sequences/{id} #
POST /sequences/v1/sequences/{id}/pause #
POST /sequences/v1/sequences/{id}/resume #
GET /sequences/v1/sequences/{id}/steps #
GET /sequences/v1/sequences/{id}/steps/{step_id} #

Documentation

📖
Documentation
https://docs.unifygtm.com/developers/api/sequences/overview
📖
APIReference
https://docs.unifygtm.com/developers/api/sequences/overview
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/rate-limits/unify-rate-limits.yml
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/authentication/unify-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/openapi/unify-sequences-api-openapi.yml
⚙
OpenAPI
https://api.unifygtm.com/sequences/v1/openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/overlays/unify-sequences-overlay.yaml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/unify/refs/heads/main/mcp/unify-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/unify-sequences-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

unify-sequences-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Unify Sequences API
  summary: Interact with sequences and sequence enrollments within the Unify platform.
  version: '1'
  termsOfService: https://www.unifygtm.com/legal/terms-and-conditions
  contact:
    name: Unify Support
    url: https://www.unifygtm.com/support
    email: support@unifygtm.com
servers:
- url: https://api.unifygtm.com
  variables: {}
security:
- ApiKeyAuth: []
tags:
- name: Sequences
paths:
  /sequences/v1/sequences:
    get:
      operationId: list_sequences
      description: 'List sequences — automated series of outreach steps (emails, tasks, and

        timing conditions) that run against enrolled people.'
      parameters:
      - name: cursor
        in: query
        required: false
        description: Opaque cursor returned by the previous page.
        schema:
          type: string
        explode: false
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
        explode: false
      responses:
        '200':
          description: Response returned when listing sequences.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSequencesResponse'
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '429':
          description: Response for any operation that exceeds a rate limit.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - rate_limited
                  message:
                    type: string
                description: Response for any operation that exceeds a rate limit.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Sequences
      x-mcp-tool:
        readOnlyHint: true
        openWorldHint: false
  /sequences/v1/sequences/{id}:
    get:
      operationId: retrieve_sequence
      description: 'Get a single sequence by its ID, including its owner, send schedule, and

        ruleset.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: Response returned when retrieving a sequence.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveSequenceResponse'
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '404':
          description: Response returned when a sequence cannot be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceNotFoundResponse'
        '429':
          description: Response for any operation that exceeds a rate limit.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - rate_limited
                  message:
                    type: string
                description: Response for any operation that exceeds a rate limit.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Sequences
      x-mcp-tool:
        readOnlyHint: true
        openWorldHint: false
    delete:
      operationId: delete_sequence
      description: Delete a sequence by its ID.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: Response returned when deleting a sequence.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSequenceSuccessResponse'
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '404':
          description: Response returned when a sequence cannot be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceNotFoundResponse'
        '429':
          description: Response for any operation that exceeds a rate limit.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - rate_limited
                  message:
                    type: string
                description: Response for any operation that exceeds a rate limit.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Sequences
      x-mcp-tool:
        idempotentHint: true
        openWorldHint: false
  /sequences/v1/sequences/{id}/pause:
    post:
      operationId: pause_sequence
      description: 'Pause a sequence, halting progress for all of its enrollments until it

        is resumed.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: Response returned when pausing a sequence.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PauseSequenceSuccessResponse'
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '404':
          description: Response returned when a sequence cannot be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceNotFoundResponse'
        '409':
          description: Response returned when a sequence state change conflicts with a concurrent update.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceStateConflictResponse'
        '429':
          description: Response for any operation that exceeds a rate limit.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - rate_limited
                  message:
                    type: string
                description: Response for any operation that exceeds a rate limit.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Sequences
      x-mcp-tool:
        destructiveHint: false
        idempotentHint: true
        openWorldHint: false
  /sequences/v1/sequences/{id}/resume:
    post:
      operationId: resume_sequence
      description: Resume a paused sequence so its enrollments continue.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: Response returned when resuming a sequence.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResumeSequenceSuccessResponse'
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '404':
          description: Response returned when a sequence cannot be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceNotFoundResponse'
        '409':
          description: Response returned when a sequence state change conflicts with a concurrent update.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceStateConflictResponse'
        '429':
          description: Response for any operation that exceeds a rate limit.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - rate_limited
                  message:
                    type: string
                description: Response for any operation that exceeds a rate limit.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Sequences
      x-mcp-tool:
        destructiveHint: false
        idempotentHint: true
  /sequences/v1/sequences/{id}/steps:
    get:
      operationId: list_sequence_steps
      description: 'List a sequence''s steps. Steps are automatic emails, manual emails, or

        tasks (calls, LinkedIn touches, action items); each step''s dependencies

        describe when it runs relative to its parent step.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: cursor
        in: query
        required: false
        description: Opaque cursor returned by the previous page.
        schema:
          type: string
        explode: false
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
        explode: false
      - name: type
        in: query
        required: false
        description: Repeat `type` to filter by multiple sequence step types.
        schema:
          type: array
          items:
            $ref: '#/components/schemas/SequenceStepType'
      responses:
        '200':
          description: Response returned when listing sequence steps.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSequenceStepsResponse'
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '404':
          description: Response returned when a sequence step cannot be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceStepNotFoundResponse'
        '429':
          description: Response for any operation that exceeds a rate limit.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - rate_limited
                  message:
                    type: string
                description: Response for any operation that exceeds a rate limit.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Sequences
      x-mcp-tool:
        readOnlyHint: true
        openWorldHint: false
  /sequences/v1/sequences/{id}/steps/{step_id}:
    get:
      operationId: retrieve_sequence_step
      description: 'Get a single step of a sequence by ID. The response shape is

        discriminated by the step''s `type`.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: step_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: Response returned when retrieving an automatic email sequence step.
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/RetrieveAutomaticEmailSequenceStepResponse'
                - $ref: '#/components/schemas/RetrieveManualEmailSequenceStepResponse'
                - $ref: '#/components/schemas/RetrieveTaskSequenceStepResponse'
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: Response for any operation that results in a bad request error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - unauthorized
                  message:
                    type: string
                description: Response for any operation that results in an unauthorized error.
        '404':
          description: Response returned when a sequence step cannot be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceStepNotFoundResponse'
        '429':
          description: Response for any operation that exceeds a rate limit.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - rate_limited
                  message:
                    type: string
                description: Response for any operation that exceeds a rate limit.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: string
                    enum:
                    - error
                  message:
                    type: string
                description: Response for any operation that results in an internal server error.
      tags:
      - Sequences
      x-mcp-tool:
        readOnlyHint: true
        openWorldHint: false
components:
  schemas:
    SequenceStepType:
      type: string
      enum:
      - AUTOMATIC_EMAIL
      - MANUAL_EMAIL
      - ACTION_ITEM
      - PHONE_CALL
      - MANUAL_LINKEDIN_PROFILE_VIEW
      - MANUAL_LINKEDIN_CONNECTION
      - MANUAL_LINKEDIN_MESSAGE
      description: Type of a sequence step.
    TaskPriority:
      type: string
      enum:
      - LOW
      - MEDIUM
      - HIGH
      - URGENT
      description: Priority assigned to tasks created by manual sequence steps.
    EmailSendScheduleRules:
      type: object
      required:
      - time_zone
      - send_days
      - skip_us_holidays
      - excluded_dates
      properties:
        time_zone:
          type: string
        send_days:
          $ref: '#/components/schemas/EmailSendDays'
        skip_us_holidays:
          type: boolean
        excluded_dates:
          type: array
          items:
            $ref: '#/components/schemas/ExcludedEmailSendDate'
      description: Sequence email send schedule rules.
    AutomaticEmailSequenceStep:
      type: object
      required:
      - type
      - config
      properties:
        type:
          type: string
          enum:
          - AUTOMATIC_EMAIL
        config:
          $ref: '#/components/schemas/SequenceEmailStepConfig'
      allOf:
      - $ref: '#/components/schemas/SequenceStepBase'
      description: Representation of an automatic email sequence step.
    ExcludedEmailSendDate:
      type: object
      required:
      - date
      properties:
        date:
          $ref: '#/components/schemas/date'
        should_recur:
          type: boolean
      description: Custom date skipped by a sequence email send schedule.
    SequenceEmailStepConfig:
      type: object
      required:
      - is_root_message
      - subject
      - fallback_subject
      - body
      - cc_recipients
      - bcc_recipients
      properties:
        is_root_message:
          type: boolean
        subject:
          type:
          - string
          - 'null'
        fallback_subject:
          type:
          - string
          - 'null'
        body:
          type: string
        cc_recipients:
          type: array
          items:
            type: string
        bcc_recipients:
          type: array
          items:
            type: string
      description: Configuration for automatic email sequence steps.
    UnitOfTime:
      type: string
      enum:
      - MINUTE
      - HOUR
      - DAY
      - WEEK
      - MONTH
      - YEAR
      description: Unit used for sequence reenrollment blocking windows.
    SequenceOwner:
      type: object
      required:
      - id
      - email
      - first_name
      - last_name
      properties:
        id:
          $ref: '#/components/schemas/uuid'
        email:
          $ref: '#/components/schemas/email'
        first_name:
          type:
          - string
          - 'null'
        last_name:
          type:
          - string
          - 'null'
      description: Owner details embedded in sequence responses.
    RetrieveTaskSequenceStepResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/TaskSequenceStep'
      description: Response returned when retrieving a manual task sequence step.
    RetrieveManualEmailSequenceStepResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/ManualEmailSequenceStep'
      description: Response returned when retrieving a manual email sequence step.
    SequenceSendSchedule:
      type: object
      required:
      - id
      - created_at
      - updated_at
      - is_default
      - name
      - rules
      properties:
        id:
          $ref: '#/components/schemas/uuid'
        created_at:
          $ref: '#/components/schemas/datetime'
        updated_at:
          $ref: '#/components/schemas/datetime'
        is_default:
          type: boolean
        name:
          type: string
        rules:
          $ref: '#/components/schemas/EmailSendScheduleRules'
      description: Email send schedule embedded in sequence responses.
    EmailSendWindow:
      type: object
      required:
      - start_time
      - end_time
      properties:
        start_time:
          $ref: '#/components/schemas/EmailSendWindowTime'
        end_time:
          $ref: '#/components/schemas/EmailSendWindowTime'
      description: Time window during which sequence emails may be sent.
    ManualEnrollmentTaskAssignment:
      type: string
      enum:
      - ASSIGN_TO_ENROLLER
      - ASSIGN_TO_MAILBOX_OWNER
      - ASSIGN_TO_USER
      description: Assignment strategy for tasks created from manual sequence enrollments.
    SequenceNotFoundResponse:
      type: object
      allOf:
      - type: object
        required:
        - status
        - message
        properties:
          status:
            type: string
            enum:
            - not_found
          message:
            type: string
        description: Response for any operation that results in a not found error.
      description: Response returned when a sequence cannot be found.
    SequenceStepTimerCondition:
      type: object
      required:
      - type
      - duration_value
      - duration_unit
      properties:
        type:
          type: string
          enum:
          - TIMER
        duration_value:
          type:
          - integer
          - 'null'
        duration_unit:
          $ref: '#/components/schemas/SequenceTimerConditionDurationUnit'
      description: Timer condition embedded in sequence step responses.
    SequenceRuleset:
      type: object
      required:
      - id
      - created_at
      - updated_at
      - name
      - is_default
      - automatic_enrollment_task_assignment
      - automatic_enrollment_task_assignment_user_id
      - manual_enrollment_task_assignment
      - manual_enrollment_task_assignment_user_id
      - opt_out_message
      - allow_same_sequence_reenrollment
      - block_reenrollment_value
      - block_reenrollment_units
      properties:
        id:
          $ref: '#/components/schemas/uuid'
        created_at:
          $ref: '#/components/schemas/datetime'
        updated_at:
          $ref: '#/components/schemas/datetime'
        name:
          type: string
        is_default:
          type: boolean
        automatic_enrollment_task_assignment:
          $ref: '#/components/schemas/AutomaticEnrollmentTaskAssignment'
        automatic_enrollment_task_assignment_user_id:
          type:
          - string
          - 'null'
          allOf:
          - $ref: '#/components/schemas/uuid'
        manual_enrollment_task_assignment:
          $ref: '#/components/schemas/ManualEnrollmentTaskAssignment'
        manual_enrollment_task_assignment_user_id:
          type:
          - string
          - 'null'
          allOf:
          - $ref: '#/components/schemas/uuid'
        opt_out_message:
          type:
          - string
          - 'null'
        allow_same_sequence_reenrollment:
          type: boolean
        block_reenrollment_value:
          type:
          - integer
          - 'null'
        block_reenrollment_units:
          allOf:
          - $ref: '#/components/schemas/UnitOfTime'
      description: Sequence ruleset embedded in sequence responses.
  

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