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

# List contacts of a sequence

> Returns a paginated list of contacts in a sequence, enriched with their tags and call history within the sequence. Supports filtering by tag label and contact status. Returns 404 if the parent sequence is in a workspace outside the API key scope.



## OpenAPI

````yaml https://api-public.skipcall.app/docs-json get /v1/sequences/{id}/contacts
openapi: 3.0.0
info:
  title: Skipcall Public API
  description: >-
    ## Overview

    The Skipcall Public API allows you to integrate Skipcall with your
    applications, CRM, or automation tools.


    ## Plan Requirements

    API access is available for **STARTER**, **INTERMÉDIAIRE** and **EXPERT**
    plans.


    ## Authentication

    All API requests require authentication using an API Key. Include your API
    key in the `Authorization` header:


    ```

    Authorization: Bearer sk_live_your_api_key_here

    ```


    You can generate API keys from your Skipcall dashboard under Settings > API
    Keys.


    ## Rate Limiting

    Rate limits vary by subscription plan:


    | Plan | Rate Limit |

    |------|------------|

    | STARTER | 100 requests/minute |

    | INTERMÉDIAIRE | 100 requests/minute |

    | EXPERT | 1000 requests/minute |


    Rate limit headers are included in every response:

    - `X-RateLimit-Limit`: Maximum requests per minute for your plan

    - `X-RateLimit-Remaining`: Remaining requests in the current window

    - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets


    ## Errors

    The API uses standard HTTP status codes:

    - `200` - Success

    - `400` - Bad Request (invalid parameters)

    - `401` - Unauthorized (invalid or missing API key)

    - `403` - Forbidden (subscription required or plan not eligible)

    - `404` - Not Found

    - `429` - Too Many Requests (rate limit exceeded)

    - `500` - Internal Server Error


    ### Subscription Errors

    | Code | Description |

    |------|-------------|

    | `SUBSCRIPTION_REQUIRED` | An active subscription is required to access the
    API |

    | `PLAN_NOT_ELIGIBLE` | API access requires STARTER, INTERMÉDIAIRE or EXPERT
    plan |
  version: '1.0'
  contact: {}
servers:
  - url: https://api-public.skipcall.app
    description: Production
security: []
tags:
  - name: Contacts
    description: Manage your contacts
  - name: Calls
    description: Access call history and recordings
paths:
  /v1/sequences/{id}/contacts:
    get:
      tags:
        - Sequences
      summary: List contacts of a sequence
      description: >-
        Returns a paginated list of contacts in a sequence, enriched with their
        tags and call history within the sequence. Supports filtering by tag
        label and contact status. Returns 404 if the parent sequence is in a
        workspace outside the API key scope.
      operationId: SequenceController_listContacts
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: Page number (1-indexed)
          schema:
            minimum: 1
            default: 1
            example: 1
            type: number
        - name: limit
          required: false
          in: query
          description: Number of items per page
          schema:
            minimum: 1
            maximum: 100
            default: 50
            example: 50
            type: number
        - name: tag
          required: false
          in: query
          description: Filter contacts by tag label
          schema:
            example: hot-lead
            type: string
        - name: status
          required: false
          in: query
          description: Filter contacts by call status
          schema:
            example: CONNECTED
            type: string
            enum:
              - CONNECTED
              - RESPONDER
              - ERROR
              - CANCELLED
              - RUNNING
              - MISSING_NUMBER
      responses:
        '200':
          description: Paginated list of sequence contacts with tags and calls
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSequenceContactsDto'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                        example: Invalid or revoked API key
                      status:
                        type: number
                        example: 401
        '403':
          description: Subscription required or plan not eligible
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: PLAN_NOT_ELIGIBLE
                      message:
                        type: string
                        example: API access requires INTERMÉDIAIRE or EXPERT plan
                      status:
                        type: number
                        example: 403
        '404':
          description: Sequence not found or outside API key scope
      security:
        - ApiKey: []
components:
  schemas:
    PaginatedSequenceContactsDto:
      type: object
      properties:
        data:
          description: Array of sequence contacts
          type: array
          items:
            $ref: '#/components/schemas/SequenceContactDto'
        total:
          type: number
          example: 100
        page:
          type: number
          example: 1
        limit:
          type: number
          example: 10
        totalPages:
          type: number
          example: 10
      required:
        - data
        - total
        - page
        - limit
        - totalPages
    SequenceContactDto:
      type: object
      properties:
        id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
          description: Unique identifier of the sequence contact record
        status:
          type: string
          enum:
            - CONNECTED
            - RESPONDER
            - ERROR
            - CANCELLED
            - RUNNING
            - MISSING_NUMBER
          example: CONNECTED
          description: Status of the contact in the sequence
          nullable: true
        contact:
          description: Contact information
          allOf:
            - $ref: '#/components/schemas/SequenceContactContactDto'
        tags:
          description: Tags associated with this contact in the sequence
          type: array
          items:
            $ref: '#/components/schemas/SequenceContactTagDto'
        calls:
          description: Calls made to this contact in the sequence
          type: array
          items:
            $ref: '#/components/schemas/SequenceContactCallDto'
        createdAt:
          format: date-time
          type: string
          example: '2024-01-15T10:30:00.000Z'
          description: Date when the contact was added to the sequence
      required:
        - id
        - contact
        - tags
        - calls
        - createdAt
    SequenceContactContactDto:
      type: object
      properties:
        id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
          description: Unique identifier of the contact
        firstName:
          type: string
          example: John
          description: First name of the contact
        lastName:
          type: string
          example: Doe
          description: Last name of the contact
        email:
          type: object
          example: john.doe@example.com
          description: Email address of the contact
          nullable: true
        company:
          type: object
          example: Acme Corp
          description: Company of the contact
          nullable: true
        phoneNumbers:
          description: Phone numbers associated with the contact
          type: array
          items:
            $ref: '#/components/schemas/SequenceContactPhoneNumberDto'
      required:
        - id
        - firstName
        - lastName
    SequenceContactTagDto:
      type: object
      properties:
        id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
          description: Unique identifier of the tag
        label:
          type: string
          example: hot-lead
          description: Label of the tag
        isSuccessTag:
          type: boolean
          example: true
          description: Whether this tag is a success tag
      required:
        - id
        - label
        - isSuccessTag
    SequenceContactCallDto:
      type: object
      properties:
        id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
          description: Unique identifier of the call session
        status:
          type: string
          enum:
            - NOT_INITIATED
            - INITIATED
            - QUEUED
            - RINGING
            - IN_PROGRESS
            - BUSY
            - NO_ANSWER
            - MISSED_CALL
            - VOICEMAIL
            - CONNECTED
            - CANCELLED
            - COMPLETED
            - ERROR_NUMBER
            - ERROR_COUNTRY
            - UNKNOWN_ERROR
          example: COMPLETED
          description: Status of the call
        startedAt:
          type: object
          example: '2024-01-15T10:30:00.000Z'
          description: Date and time when the call started
          nullable: true
        endedAt:
          type: object
          example: '2024-01-15T10:32:30.000Z'
          description: Date and time when the call ended
          nullable: true
        durationSeconds:
          type: object
          example: 150
          description: Duration of the call in seconds (endedAt - startedAt)
          nullable: true
        createdAt:
          format: date-time
          type: string
          example: '2024-01-15T10:30:00.000Z'
          description: Date and time when the call record was created
      required:
        - id
        - status
        - createdAt
    SequenceContactPhoneNumberDto:
      type: object
      properties:
        id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
          description: Unique identifier of the phone number
        number:
          type: string
          example: '+33612345678'
          description: Phone number in E.164 format
      required:
        - id
        - number
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: API Key
      type: http
      description: Enter your API Key (sk_live_xxx or sk_test_xxx)

````