> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spott.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List outreach sequences

> Returns a list of outreach sequences. Uses cursor pagination.



## OpenAPI

````yaml /api-reference/openapi.json get /outreach-sequences
openapi: 3.1.0
info:
  title: Spott API Reference
  version: '0.1'
servers:
  - url: https://api.gospott.com
security: []
tags: []
paths:
  /outreach-sequences:
    get:
      tags:
        - Outreach Sequences
      summary: List outreach sequences
      description: Returns a list of outreach sequences. Uses cursor pagination.
      operationId: getOutreachSequences
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1-100, default 25).
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: integer
        - name: searchQuery
          required: false
          in: query
          description: >-
            Case-insensitive partial match on the sequence name. Must be at
            least 3 characters when provided.
          schema:
            minLength: 3
            type: string
      responses:
        '200':
          description: >-
            Successfully retrieved outreach sequences. Returns items array with
            pagination info containing cursor for the next page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOutreachSequencesResponseDto'
        '400':
          description: >-
            Bad request - invalid query parameters (e.g., limit out of range,
            invalid cursor, searchQuery too short)
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ExceptionBaseDto'
                  - type: object
                    properties:
                      statusCode:
                        type: number
                        example: 400
                      message:
                        type: string
                        example: Limit must be between 1 and 100
                      error:
                        type: string
                        example: Bad Request
        '401':
          description: Unauthorized - invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
        '500':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
      security:
        - x-api-key: []
components:
  schemas:
    GetOutreachSequencesResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/OutreachSequenceDto'
          description: Sequences in the current page, sorted by modifiedAt desc.
        pagination:
          $ref: '#/components/schemas/OutreachSequenceCursorPaginationDto'
          description: Cursor pagination metadata.
      required:
        - items
        - pagination
      id: PrivateGetOutreachSequencesResponseDto
    ExceptionBaseDto:
      type: object
      properties:
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        message:
          type: string
        requestId:
          type: string
      required:
        - status
        - message
        - requestId
      id: ExceptionBaseDto
    OutreachSequenceDto:
      type: object
      properties:
        id:
          type: string
          description: Outreach sequence ID.
        name:
          type: string
          description: Display name of the sequence.
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: Free-text description of the sequence.
        status:
          type: string
          enum:
            - PENDING
            - ONGOING
            - CANCELLED
            - COMPLETED
          description: Lifecycle status of the sequence.
        purpose:
          type: string
          enum:
            - GENERIC
            - VACANCY_PRESENTATION
            - SPECULATIVE_PRESENTATION
          description: Purpose of the sequence.
        vacancy:
          anyOf:
            - $ref: '#/components/schemas/OutreachSequenceReferenceDto'
            - type: 'null'
          description: Set when purpose is VACANCY_PRESENTATION, null otherwise.
        candidate:
          anyOf:
            - $ref: '#/components/schemas/OutreachSequenceReferenceDto'
            - type: 'null'
          description: Set when purpose is SPECULATIVE_PRESENTATION, null otherwise.
        createdBy:
          $ref: '#/components/schemas/OutreachSequenceReferenceDto'
          type: object
          properties:
            id:
              type: string
              minLength: 1
          required:
            - id
          description: User who created the sequence.
        createdAt:
          $ref: '#/components/schemas/DateISO'
          description: When the sequence was created.
        modifiedAt:
          $ref: '#/components/schemas/DateISO'
          description: When the sequence was last modified. Used as the cursor sort key.
      required:
        - id
        - name
        - description
        - status
        - purpose
        - vacancy
        - candidate
        - createdBy
        - createdAt
        - modifiedAt
      id: PrivateOutreachSequenceDto
    OutreachSequenceCursorPaginationDto:
      type: object
      properties:
        cursor:
          anyOf:
            - type: object
              properties:
                modifiedAt:
                  $ref: '#/components/schemas/DateISO'
                id:
                  type: string
              required:
                - modifiedAt
                - id
            - type: 'null'
          type:
            - string
            - 'null'
        hasMore:
          type: boolean
          deprecated: true
          description: >-
            Use the cursor presence to identify if there are more results to
            fetch instead. This property will be removed in a future release
      required:
        - cursor
        - hasMore
      id: PrivateOutreachSequenceCursorPaginationDto
    OutreachSequenceReferenceDto:
      $ref: '#/components/schemas/IdDto'
      id: PrivateOutreachSequenceReferenceDto
    DateISO:
      id: DateISO
      format: date-time
      anyOf:
        - type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        - type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
    IdDto:
      type: object
      properties:
        id:
          type: string
          minLength: 1
      required:
        - id
      id: IdDto
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        API key for authentication. Get your API key from Settings → API Keys in
        your Spott dashboard.

````