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

# List subscription phone numbers

> Retrieve a paginated list of phone numbers and their subscription statuses for a specific subscription configuration.

You can optionally filter by subscription state (SUB or UNSUB).




## OpenAPI

````yaml get /v2/notify/management/subscriptions/{config_id}/phone_numbers
openapi: 3.1.0
info:
  title: Prelude API
  version: 2.0.0
  description: The Prelude API allows you to send messages to your users.
  contact:
    email: support@prelude.so
servers:
  - url: https://api.prelude.dev
    description: Production server
security:
  - apiToken: []
tags:
  - name: Notify
    description: Send transactional and marketing messages with compliance enforcement.
  - name: Transactional
    description: Send transactional messages (deprecated - use Notify API instead).
  - name: Verify
    description: Verify phone numbers.
  - name: Watch
    description: Evaluate email addresses and phone numbers for trustworthiness.
  - name: Lookup
    description: >-
      Retrieve detailed information about a phone number including carrier data,
      line type, and portability status.
paths:
  /v2/notify/management/subscriptions/{config_id}/phone_numbers:
    get:
      tags:
        - Notify
      summary: List subscription phone numbers
      description: >
        Retrieve a paginated list of phone numbers and their subscription
        statuses for a specific subscription configuration.


        You can optionally filter by subscription state (SUB or UNSUB).
      operationId: listSubscriptionPhoneNumbers
      parameters:
        - name: config_id
          in: path
          required: true
          schema:
            type: string
          description: The subscription configuration ID
        - name: state
          in: query
          required: false
          schema:
            type: string
            enum:
              - SUB
              - UNSUB
          description: Filter by subscription state
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          description: Maximum number of phone numbers to return per page
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Pagination cursor from the previous response
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscriptionPhoneNumbersResponse'
        '400':
          description: KO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ListSubscriptionPhoneNumbersResponse:
      type: object
      required:
        - phone_numbers
      properties:
        phone_numbers:
          type: array
          description: A list of phone numbers and their subscription statuses.
          items:
            type: object
            required:
              - config_id
              - phone_number
              - state
              - source
              - updated_at
            properties:
              config_id:
                type: string
                description: The subscription configuration ID.
                examples:
                  - subcfg_01k8ap1btqf5r9fq2c8ax5fhc9
              phone_number:
                type: string
                format: phone_number
                description: The phone number in E.164 format.
                examples:
                  - '+33612345678'
              state:
                type: string
                enum:
                  - SUB
                  - UNSUB
                description: |
                  The subscription state:
                    * `SUB` - Subscribed (user can receive marketing messages)
                    * `UNSUB` - Unsubscribed (user has opted out)
              source:
                type: string
                enum:
                  - MO_KEYWORD
                  - API
                  - CSV_IMPORT
                  - CARRIER_DISCONNECT
                description: |
                  How the subscription state was changed:
                    * `MO_KEYWORD` - User sent a keyword (STOP/START)
                    * `API` - Changed via API
                    * `CSV_IMPORT` - Imported from CSV
                    * `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
              reason:
                type: string
                description: >-
                  Additional context about the state change (e.g., the keyword
                  that was sent).
                examples:
                  - STOP
              updated_at:
                type: string
                format: date-time
                description: >-
                  The date and time when the subscription status was last
                  updated.
                examples:
                  - '2024-01-01T12:00:00Z'
        next_cursor:
          type: string
          description: >-
            Pagination cursor for the next page of results. Omitted if there are
            no more pages.
          examples:
            - eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ==
    Error:
      type: object
      properties:
        code:
          type: string
          description: The error code.
          examples:
            - invalid_phone_number
        message:
          type: string
          examples:
            - >-
              The provided phone number is invalid. Provide a valid E.164 phone
              number.
          description: A human-readable message describing the error.
        type:
          type: string
          examples:
            - bad_request
          description: The error type.
        request_id:
          type: string
          examples:
            - 3d19215e-2991-4a05-a41a-527314e6ff6a
          description: >-
            A string that identifies this specific request. Report it back to us
            to help us diagnose your issues.
      required:
        - code
        - message
        - type
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer

````