> ## 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.

# Get a watchlist

> One watchlist, with its counts.



## OpenAPI

````yaml /api/openapi.json get /watchlists/{watchlist_id}
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:
  /watchlists/{watchlist_id}:
    get:
      tags:
        - Watchlists
      summary: Get a watchlist
      description: One watchlist, with its counts.
      operationId: get_watchlists_watchlist_id
      parameters:
        - name: watchlist_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchlistResponse'
        '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:
    WatchlistResponse:
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
        created_by:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        check_frequency_hours:
          additionalProperties:
            anyOf:
              - type: number
              - type: 'null'
          type: object
        cadence_hours:
          type: integer
          default: 168
        role_filters:
          items:
            type: string
          type: array
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        company_count:
          type: integer
          default: 0
        pending_count:
          type: integer
          default: 0
        resolved_count:
          type: integer
          default: 0
        unresolved_count:
          type: integer
          default: 0
        people_count:
          type: integer
          default: 0
        last_run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        latest_event:
          anyOf:
            - $ref: '#/components/schemas/WatchlistLatestEvent'
            - type: 'null'
        new_today:
          type: integer
          default: 0
        quiet_this_week:
          anyOf:
            - type: boolean
            - type: 'null'
      type: object
      required:
        - id
        - name
        - status
        - created_at
        - updated_at
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    WatchlistLatestEvent:
      properties:
        kind:
          type: string
        title:
          type: string
        at:
          type: string
          format: date-time
        tag:
          anyOf:
            - type: string
            - type: 'null'
        person:
          anyOf:
            - $ref: '#/components/schemas/WatchlistLatestEventPerson'
            - type: 'null'
      type: object
      required:
        - kind
        - title
        - at
    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
    WatchlistLatestEventPerson:
      properties:
        name:
          type: string
        title:
          anyOf:
            - type: string
            - type: 'null'
        avatar_url:
          anyOf:
            - type: string
            - type: 'null'
        lead_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
      type: object
      required:
        - name
  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.