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

# List leads by evaluation segment

> Filter + priority-sort connected leads by evaluation metrics (Leads tab)

**Required scope:** `intel.view`


## OpenAPI

````yaml /api-reference/openapi.json get /campaigns/{id}/segmented-leads
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /campaigns/{id}/segmented-leads:
    get:
      summary: List leads by evaluation segment
      description: Filter + priority-sort connected leads by evaluation metrics (Leads tab)
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 200
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
          required: false
          name: offset
          in: query
        - schema:
            type: array
            nullable: true
            items:
              type: string
            maxItems: 20
          required: false
          name: interestLevel
          in: query
        - schema:
            type: array
            nullable: true
            items:
              type: string
            maxItems: 20
          required: false
          name: qualification
          in: query
        - schema:
            type: array
            nullable: true
            items:
              type: string
            maxItems: 20
          required: false
          name: callResult
          in: query
        - schema:
            type: boolean
            nullable: true
          required: false
          name: callbackDue
          in: query
        - schema:
            type: string
          required: false
          name: search
          in: query
        - schema:
            type: array
            nullable: true
            items:
              type: string
              pattern: ^[^:]+:.+$
            maxItems: 20
          required: false
          name: mf
          in: query
        - schema:
            type: string
            enum:
              - priority
              - recent
              - duration
              - attempts
          required: false
          name: sort
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            maximum: 86400
          required: false
          name: minDurationSec
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            maximum: 86400
          required: false
          name: maxDurationSec
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            maximum: 100
          required: false
          name: minAttempts
          in: query
        - schema:
            type: string
          required: false
          name: calledFrom
          in: query
        - schema:
            type: string
          required: false
          name: calledTo
          in: query
        - schema:
            type: boolean
            nullable: true
          required: false
          name: includeUnscored
          in: query
        - schema:
            type: array
            nullable: true
            items:
              type: string
            maxItems: 20
          required: false
          name: disposition
          in: query
        - schema:
            type: array
            nullable: true
            items:
              type: string
            maxItems: 20
          required: false
          name: tags
          in: query
        - schema:
            type: string
            enum:
              - messaged
              - needs_reply
              - replied
              - read
              - delivered
              - failed
          required: false
          name: whatsapp
          in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        callId:
                          type: string
                        contactId:
                          type: string
                        name:
                          type: string
                          nullable: true
                        toNumber:
                          type: string
                        status:
                          type: string
                        outcome:
                          type: string
                          nullable: true
                        durationMs:
                          type: number
                          nullable: true
                        attemptNumber:
                          type: number
                          nullable: true
                        dialReason:
                          type: string
                          nullable: true
                        attemptCount:
                          type: number
                        queuedAt:
                          type: string
                        receivedAt:
                          type: string
                        firstCallInitiatedAt:
                          type: string
                          nullable: true
                        waitMs:
                          type: number
                          nullable: true
                        isApiLead:
                          type: boolean
                        interestLevel:
                          type: string
                          nullable: true
                        qualification:
                          type: string
                          nullable: true
                        callbackAt:
                          type: string
                          nullable: true
                        metrics:
                          type: object
                          additionalProperties:
                            type: string
                        fields:
                          type: object
                          additionalProperties:
                            type: string
                        priorityRank:
                          type: number
                        doNotCall:
                          type: boolean
                        disposition:
                          type: string
                        leadTags:
                          type: array
                          items:
                            type: string
                        whatsappState:
                          type: string
                          nullable: true
                          enum:
                            - NEEDS_REPLY
                            - REPLIED
                            - READ
                            - DELIVERED
                            - SENT
                            - FAILED
                            - RETRYING
                        whatsappLastMessageAt:
                          type: string
                          nullable: true
                      required:
                        - callId
                        - contactId
                        - name
                        - toNumber
                        - status
                        - outcome
                        - durationMs
                        - attemptNumber
                        - dialReason
                        - attemptCount
                        - queuedAt
                        - receivedAt
                        - firstCallInitiatedAt
                        - waitMs
                        - isApiLead
                        - interestLevel
                        - qualification
                        - callbackAt
                        - metrics
                        - fields
                        - priorityRank
                        - doNotCall
                        - disposition
                        - leadTags
                        - whatsappState
                        - whatsappLastMessageAt
                  total:
                    type: number
                required:
                  - items
                  - total
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.