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

# List people and their results

> One page of this campaign's people, with where each one is and what happened. Use this to read results.



## OpenAPI

````yaml /api/openapi.json get /workflows/{workflow_id}/analytics/leads
openapi: 3.1.0
info:
  title: B2B Signals API
  version: '1.0'
  description: >-
    Add people, run campaigns and read results from your own tools. Every
    request needs your API key in the `X-API-Key` header.
servers:
  - url: https://api.b2bsignals.ai/api/v1
security:
  - apiKey: []
tags:
  - name: Add people
    description: >-
      Send people in from your own tools, one at a time or up to 100 per
      request.
  - name: People
    description: >-
      Read and change the people in your workspace. In API paths and fields, a
      person is a `lead`.
  - name: Notes and tasks
    description: Notes on a person, and follow-up tasks.
  - name: Lists
    description: >-
      Named groups of people you can add to a campaign. In API paths, a list is
      a `lead-list`.
  - name: Campaigns
    description: >-
      Read, start, pause and report on campaigns. In API paths and fields, a
      campaign is a `workflow`.
  - name: Campaign people
    description: >-
      One person's place in one campaign. In API paths and fields, that is a
      `workflow-run`.
  - name: Approvals
    description: Messages waiting for a yes or no before they go out.
  - name: Inbox
    description: Read conversations and keep them organized.
  - name: Do not contact
    description: People and companies that must never be contacted.
  - name: Senders
    description: >-
      The LinkedIn accounts that send for your workspace. In API paths, a sender
      is a `connected-account`.
  - name: Webhooks
    description: Send events to your own tools.
  - name: Integrations
    description: See which outside tools are connected, and send people to them.
  - name: Reports
    description: The numbers behind Reports, and exports.
  - name: Watchlists
    description: Read the companies and people you watch.
  - name: Search
    description: Search across people, campaigns, lists and watchlists.
paths:
  /workflows/{workflow_id}/analytics/leads:
    get:
      tags:
        - Campaigns
      summary: List people and their results
      description: >-
        One page of this campaign's people, with where each one is and what
        happened. Use this to read results.
      operationId: get_workflows_workflow_id_analytics_leads
      parameters:
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: intent
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: outcome
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
          description: Text to search for.
        - name: days
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 3650
                minimum: 1
              - type: 'null'
          description: Only the last this many days.
        - name: sender
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
        - name: tag
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: has_reply
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
        - name: run_state
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: tab
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
          description: How many rows to skip. Starts at 0.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
          description: How many rows to return in one page.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadAnalyticsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: The request did not pass validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    LeadAnalyticsResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/LeadAnalyticsItem'
          type: array
        total:
          type: integer
        status_counts:
          anyOf:
            - $ref: '#/components/schemas/CampaignStatusCounts'
            - type: 'null'
        reasons:
          anyOf:
            - $ref: '#/components/schemas/CampaignStatusReasons'
            - type: 'null'
      type: object
      required:
        - items
        - total
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    LeadAnalyticsItem:
      properties:
        run_id:
          type: string
          format: uuid
        lead_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        person_name:
          anyOf:
            - type: string
            - type: 'null'
        name_unresolved:
          type: boolean
          default: false
        person_title:
          anyOf:
            - type: string
            - type: 'null'
        person_linkedin_url:
          anyOf:
            - type: string
            - type: 'null'
        avatar_url:
          anyOf:
            - type: string
            - type: 'null'
        company_name:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
        progress_percent:
          type: integer
          default: 0
        progress_label:
          anyOf:
            - type: string
            - type: 'null'
        last_action:
          anyOf:
            - $ref: '#/components/schemas/LastAction'
            - type: 'null'
        connected:
          type: boolean
          default: false
        replied:
          type: boolean
          default: false
        sender_display_name:
          anyOf:
            - type: string
            - type: 'null'
        reply_intent:
          anyOf:
            - type: string
            - type: 'null'
        connected_account_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        user_paused:
          type: boolean
          default: false
        campaign_paused:
          type: boolean
          default: false
        status_label:
          anyOf:
            - type: string
            - type: 'null'
        tags:
          items:
            type: string
          type: array
        has_conversation:
          type: boolean
          default: false
        can_reassign:
          type: boolean
          default: false
        reassign_blocked_reason:
          anyOf:
            - type: string
            - type: 'null'
        can_retry:
          type: boolean
          default: false
        can_remove:
          type: boolean
          default: false
        messages:
          items:
            $ref: '#/components/schemas/LeadMessageColumn'
          type: array
        where_label:
          anyOf:
            - type: string
            - type: 'null'
        next_label:
          anyOf:
            - type: string
            - type: 'null'
        next_action:
          anyOf:
            - type: string
            - type: 'null'
        next_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        waiting_for_you:
          type: boolean
          default: false
        error_code:
          anyOf:
            - type: string
            - type: 'null'
        error_reason:
          anyOf:
            - type: string
            - type: 'null'
        failed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        failed_step_label:
          anyOf:
            - type: string
            - type: 'null'
        sender_back:
          anyOf:
            - type: boolean
            - type: 'null'
      type: object
      required:
        - run_id
        - status
    CampaignStatusCounts:
      properties:
        in_progress:
          type: integer
          default: 0
        finished:
          type: integer
          default: 0
        paused:
          type: integer
          default: 0
        failed:
          type: integer
          default: 0
        excluded:
          type: integer
          default: 0
        not_enrolled:
          type: integer
          default: 0
        waiting_for_you:
          type: integer
          default: 0
        didnt_go_out:
          type: integer
          default: 0
        removed:
          type: integer
          default: 0
        replied:
          type: integer
          default: 0
      type: object
    CampaignStatusReasons:
      properties:
        failed:
          items:
            $ref: '#/components/schemas/StatusReason'
          type: array
        excluded:
          items:
            $ref: '#/components/schemas/StatusReason'
          type: array
        not_enrolled:
          items:
            $ref: '#/components/schemas/StatusReason'
          type: array
      type: object
    Error:
      type: object
      required:
        - detail
      properties:
        detail:
          description: A message, or an object with a `code` and a `message`.
          anyOf:
            - type: string
            - type: object
              properties:
                code:
                  type: string
                message:
                  type: string
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
    LastAction:
      properties:
        node_type:
          anyOf:
            - type: string
            - type: 'null'
        send_type:
          anyOf:
            - type: string
            - type: 'null'
        at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        text:
          anyOf:
            - type: string
            - type: 'null'
        outcome:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    LeadMessageColumn:
      properties:
        label:
          type: string
        kind:
          type: string
        text:
          anyOf:
            - type: string
            - type: 'null'
        sent:
          type: boolean
          default: false
        note_sent:
          anyOf:
            - type: boolean
            - type: 'null'
        note_status_text:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - label
        - kind
    StatusReason:
      properties:
        code:
          type: string
        text:
          type: string
        count:
          type: integer
      type: object
      required:
        - code
        - text
        - count
  responses:
    Unauthorized:
      description: The key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The key cannot do this, or your plan does not include it. `detail` says
        which.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your workspace's API key. It starts with `b2b_sk_`.

````

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