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

# List clients in a pipeline

> List every active client on a pipeline together with its current stage.

The list is not paginated; archived (removed) clients are excluded.



## OpenAPI

````yaml GET /api/v2/public/salesflow/pipelines/{pipeline_id}/clients
openapi: 3.1.0
info:
  title: Dialtu Public API
  version: '2.0'
  description: >-
    Programmatic access to your Dialtu account: schedule AI voice calls, create
    contacts, push leads into Salesflow pipelines, book calendar appointments
    and read WhatsApp conversation history.


    Every request is authenticated with an API key created in the dashboard
    under **Settings → API Keys**, sent as `Authorization: Bearer pk_...`.
servers:
  - url: https://api.dialtu.com
    description: Production
  - url: https://api.stg.dialtu.com
    description: Staging
security:
  - ApiKeyBearer: []
tags:
  - name: Calls
    description: Schedule outbound AI voice calls.
  - name: Clients
    description: Create contacts in your account.
  - name: Salesflow
    description: Push leads into a pipeline through an API input node.
  - name: Salesflow pipelines
    description: Read a pipeline's stages and add, move or remove clients.
  - name: Calendar
    description: Check bookable capacity, book appointments and manage waiting lists.
  - name: WhatsApp
    description: Read-only conversation history and transcripts.
paths:
  /api/v2/public/salesflow/pipelines/{pipeline_id}/clients:
    get:
      tags:
        - Salesflow pipelines
      summary: List clients in a pipeline
      description: |-
        List every active client on a pipeline together with its current stage.

        The list is not paginated; archived (removed) clients are excluded.
      operationId: listPipelineClients
      parameters:
        - in: path
          name: pipeline_id
          schema:
            description: >-
              ID of the pipeline. Shown in the Salesflow editor URL and in the
              pipeline settings.
            title: Pipeline Id
            type: integer
          required: true
          description: >-
            ID of the pipeline. Shown in the Salesflow editor URL and in the
            pipeline settings.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPipelineClientListResponse'
        '401':
          description: Missing, malformed or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailErrorResponse'
              examples:
                missing_header:
                  summary: No Authorization header
                  value:
                    detail: Unauthorized
                invalid_key:
                  summary: Unknown or revoked key
                  value:
                    detail: Invalid or expired API key. Please check your credentials.
        '422':
          description: The request did not match the documented schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestValidationError'
              example:
                detail:
                  - type: missing
                    loc:
                      - body
                      - payload
                      - phone_number
                    msg: Field required
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPipelineErrorResponse'
      security:
        - ApiKeyBearer: []
components:
  schemas:
    PublicPipelineClientListResponse:
      description: Response for listing pipeline clients.
      properties:
        status:
          const: success
          default: success
          description: Always `success`.
          title: Status
          type: string
        data:
          description: Active clients on the pipeline.
          items:
            $ref: '#/components/schemas/PublicPipelineClientSchema'
          title: Data
          type: array
        count:
          default: 0
          description: Number of clients returned.
          title: Count
          type: integer
      title: PublicPipelineClientListResponse
      type: object
    DetailErrorResponse:
      description: 'Plain error body: `{"detail": "..."}`. No `error_code` is included.'
      properties:
        detail:
          description: Human-readable reason for the failure.
          title: Detail
          type: string
      required:
        - detail
      title: DetailErrorResponse
      type: object
    RequestValidationError:
      title: RequestValidationError
      type: object
      description: >-
        Returned when the request body, query string or path could not be parsed
        against the documented schema. Fix the listed fields and retry.
      properties:
        detail:
          type: array
          title: Detail
          description: One entry per invalid field.
          items:
            $ref: '#/components/schemas/RequestValidationErrorItem'
      required:
        - detail
    PublicPipelineErrorResponse:
      description: Error response for pipeline operations.
      properties:
        status:
          const: error
          description: Error status
          title: Status
          type: string
        error_code:
          description: Machine-readable error code
          title: Error Code
          type: string
        message:
          description: Human-readable error message
          title: Message
          type: string
      required:
        - status
        - error_code
        - message
      title: PublicPipelineErrorResponse
      type: object
    PublicPipelineClientSchema:
      description: Client state in a pipeline.
      properties:
        client_id:
          description: Client ID (use it with the add/remove/move endpoints).
          title: Client Id
          type: integer
        client_name:
          description: Full name of the client.
          title: Client Name
          type: string
        client_phone:
          anyOf:
            - type: string
            - type: 'null'
          description: Phone number, when known.
          title: Client Phone
        client_email:
          anyOf:
            - type: string
            - type: 'null'
          description: Email address, when known.
          title: Client Email
        stage_id:
          description: ID of the stage the client is currently in.
          title: Stage Id
          type: integer
        stage_name:
          description: Name of that stage.
          title: Stage Name
          type: string
        status:
          description: >-
            Pipeline status: `active`, `completed`, or `removed` (this endpoint
            returns `active`).
          title: Status
          type: string
        created_at:
          description: When the client entered the pipeline (UTC, ISO 8601).
          format: date-time
          title: Created At
          type: string
      required:
        - client_id
        - client_name
        - stage_id
        - stage_name
        - status
        - created_at
      title: PublicPipelineClientSchema
      type: object
    RequestValidationErrorItem:
      title: RequestValidationErrorItem
      type: object
      properties:
        loc:
          type: array
          title: Loc
          description: >-
            Where the problem is: the first element is `body`, `query` or
            `path`, followed by the field path.
          items:
            anyOf:
              - type: string
              - type: integer
        msg:
          type: string
          title: Msg
          description: What is wrong with the value.
        type:
          type: string
          title: Type
          description: >-
            Machine-readable validation error type, e.g. `missing` or
            `int_parsing`.
      required:
        - loc
        - msg
        - type
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: pk_...
      description: >-
        API key created in the dashboard under **Settings → API Keys**. Send it
        as `Authorization: Bearer pk_...`.

````