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

# Get subscription phone number status

> Retrieve the current subscription status for a specific phone number within a subscription configuration.




## OpenAPI

````yaml get /v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}
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/{phone_number}:
    get:
      tags:
        - Notify
      summary: Get subscription phone number status
      description: >
        Retrieve the current subscription status for a specific phone number
        within a subscription configuration.
      operationId: getSubscriptionPhoneNumber
      parameters:
        - name: config_id
          in: path
          required: true
          schema:
            type: string
          description: The subscription configuration ID
        - name: phone_number
          in: path
          required: true
          schema:
            type: string
          description: The phone number in E.164 format (e.g., +33612345678)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionPhoneNumberResponse'
        '400':
          description: KO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GetSubscriptionPhoneNumberResponse:
      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'
    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

````