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

# Get a calling list

> Read the current name, owner, group and contact count for a calling list, for example before displaying a campaign in your integration. Requires `lists:read`. Use the numeric ID returned when the list was created or listed; list names do not uniquely identify records.

The key must permit the list's workspace and owner. The response contains list details, not embedded contacts. To enumerate members, use `GET /lists/{id}/contacts` with both list-read and contact-read permission. Its visible contact page can be smaller than the list's total contact count because contact ownership is checked separately.

A `404 not_found` means the list is missing or inaccessible. For `400 invalid_request`, supply a positive numeric ID; for `403 insufficient_scope`, use a key with list-read permission. This read needs no idempotency key and can be retried after transient failures.

See [calling lists](/guides/contact-lists).



## OpenAPI

````yaml /api/openapi.json get /lists/{id}
openapi: 3.1.0
info:
  title: PowerDialer API v2
  version: 2.0.0
  description: >-
    Connect your CRM, sales workspace or reporting tools to PowerDialer using
    scoped API keys. Manage contacts and calling lists, read call evidence and
    analytics, and receive signed events. All example records and IDs are
    synthetic; replace them with values from your workspace. Shared-key v1 is
    retired. API availability was verified on 2026-10-08; see /availability for
    historical data coverage. Legacy outbound webhooks use a separate contract.
servers:
  - url: https://api.migration.powerdialer.ai/api/public/v2
    description: Production API v2; availability verified on 2026-10-08.
security:
  - ApiKey: []
tags:
  - name: Authentication
  - name: Contacts
  - name: Calling lists
  - name: Imports
  - name: Calls
  - name: Synchronization
  - name: Analytics
  - name: Webhooks
  - name: Webhook deliveries
  - name: Incoming webhook payloads
paths:
  /lists/{id}:
    get:
      tags:
        - Calling lists
      summary: Get a calling list
      description: >-
        Read the current name, owner, group and contact count for a calling
        list, for example before displaying a campaign in your integration.
        Requires `lists:read`. Use the numeric ID returned when the list was
        created or listed; list names do not uniquely identify records.


        The key must permit the list's workspace and owner. The response
        contains list details, not embedded contacts. To enumerate members, use
        `GET /lists/{id}/contacts` with both list-read and contact-read
        permission. Its visible contact page can be smaller than the list's
        total contact count because contact ownership is checked separately.


        A `404 not_found` means the list is missing or inaccessible. For `400
        invalid_request`, supply a positive numeric ID; for `403
        insufficient_scope`, use a key with list-read permission. This read
        needs no idempotency key and can be retried after transient failures.


        See [calling lists](/guides/contact-lists).
      operationId: getListsById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
            maximum: 2147483647
          description: >-
            Numeric calling-list ID returned by POST /lists or GET /lists. The
            list must be visible to this credential.
          example: 456
      responses:
        '200':
          description: >-
            Current details and total membership count for the visible calling
            list.
          headers:
            X-Request-Id:
              schema:
                type: string
                format: uuid
            RateLimit-Limit:
              schema:
                type: integer
            RateLimit-Remaining:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/List'
              example:
                name: October inbound leads
                ownerId: user_example
                groupName: Inbound
                id: 456
                orgId: org_example
                createdAt: '2026-10-08T12:00:00.000Z'
                updatedAt: '2026-10-08T12:00:00.000Z'
                contactsCount: 1
        default:
          description: >-
            Error. 400 invalid request; 401 invalid credential; 403 insufficient
            access; 404 not found; 409 state/idempotency conflict; 413 size
            limit; 422 verification failure; 429 rate limit (Retry-After
            seconds); 503 temporary service failure.
          headers:
            Retry-After:
              schema:
                type: integer
            X-Request-Id:
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: invalid_api_key
                  message: API key is invalid, expired or revoked
                  requestId: 00000000-0000-4000-8000-000000000004
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            # Replace example resource IDs and ownerId with values from your
            workspace.

            : "${POWERDIALER_API_KEY:?Set POWERDIALER_API_KEY to your scoped API
            key}"

            curl --request GET \
              --url 'https://api.migration.powerdialer.ai/api/public/v2/lists/456' \
              --header "Authorization: Bearer $POWERDIALER_API_KEY"
components:
  schemas:
    List:
      type: object
      properties:
        id:
          type: integer
          description: >-
            PowerDialer list ID. Use this integer in list URLs and analytics
            filters.
        name:
          type: string
          description: Calling-list display name.
        ownerId:
          type: string
          description: PowerDialer member who owns this list.
        orgId:
          anyOf:
            - type: string
            - type: 'null'
          description: Workspace identifier stored on the list.
        groupName:
          anyOf:
            - type: string
            - type: 'null'
          description: Optional grouping label, or null.
        createdAt:
          type: string
          format: date-time
          description: List creation time in UTC.
        updatedAt:
          type: string
          format: date-time
          description: Last list update time in UTC.
        contactsCount:
          type: integer
          description: >-
            Stored total membership count for the list. It may exceed the
            contacts visible to a restricted key.
      required:
        - id
        - name
        - ownerId
        - orgId
        - groupName
        - createdAt
        - updatedAt
        - contactsCount
      examples:
        - name: October inbound leads
          ownerId: user_example
          groupName: Inbound
          id: 456
          orgId: org_example
          createdAt: '2026-10-08T12:00:00.000Z'
          updatedAt: '2026-10-08T12:00:00.000Z'
          contactsCount: 1
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable machine-readable error code.
            message:
              type: string
              description: Human-readable explanation.
            requestId:
              type: string
              format: uuid
              description: Request identifier to include when investigating a failure.
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
                required:
                  - path
                  - message
              description: Validation errors, when available.
          required:
            - code
            - message
            - requestId
      required:
        - error
      examples:
        - error:
            code: insufficient_scope
            message: Requires contacts:read
            requestId: 00000000-0000-4000-8000-000000000004
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: pd_<live|test>_<credential UUID>.<random secret>
      description: >-
        Issued in Developers. Workspace/owner/scopes come from credential, never
        acting-user headers. API keys cannot manage API credentials.

````

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