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

# List Blacklist Phone Numbers



## OpenAPI

````yaml https://voice.getprosperapp.com/openapi.json get /api/v1/blacklists/{blacklist_id}/phone-numbers
openapi: 3.1.0
info:
  title: Prosper Voice
  version: 1.0.0
servers: []
security: []
paths:
  /api/v1/blacklists/{blacklist_id}/phone-numbers:
    get:
      tags:
        - Blacklists
      summary: List Blacklist Phone Numbers
      operationId: >-
        list_blacklist_phone_numbers_api_v1_blacklists__blacklist_id__phone_numbers_get
      parameters:
        - name: blacklist_id
          in: path
          required: true
          schema:
            type: string
            description: The blacklist to read.
            title: Blacklist Id
          description: The blacklist to read.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 1
            description: Page size.
            default: 1000
            title: Limit
          description: Page size.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: How many numbers to skip.
            default: 0
            title: Offset
          description: How many numbers to skip.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlacklistPhoneNumbersResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    BlacklistPhoneNumbersResponse:
      properties:
        phone_numbers:
          items:
            $ref: '#/components/schemas/BlacklistPhoneNumberResponse'
          type: array
          title: Phone Numbers
          description: One page of the list, ordered by phone number.
        total:
          type: integer
          title: Total
          description: >-
            How many numbers the list holds in total, ignoring paging. Page
            until the numbers you have seen reach this.
      type: object
      required:
        - phone_numbers
        - total
      title: BlacklistPhoneNumbersResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BlacklistPhoneNumberResponse:
      properties:
        phone_number:
          type: string
          title: Phone Number
          description: The number as stored.
        reason:
          type: string
          title: Reason
          description: Why the number is on the list.
        level:
          type: string
          title: Level
          description: Severity.
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Label, if one was given.
        comment:
          anyOf:
            - type: string
            - type: 'null'
          title: Comment
          description: Free text, if any was given.
      type: object
      required:
        - phone_number
        - reason
        - level
        - name
        - comment
      title: BlacklistPhoneNumberResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

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