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

# List phone numbers

> Retrieves all SIP phone numbers for your organization with support for pagination and filtering.
Filter by phone number, linked agent, or unlinked status.



## OpenAPI

````yaml https://blackbox.dasha.ai/swagger/v1/swagger.json get /api/v1/sip-phone-numbers
openapi: 3.0.4
info:
  title: Dasha BlackBox Agent API
  description: API for managing AI agents and calls
  contact:
    name: DashaAI Team
    email: support@dasha.ai
  version: v1
servers:
  - url: https://blackbox.dasha.ai
    description: Dasha BlackBox Agent API
security:
  - {}
  - {}
tags:
  - name: ActivityLogs
  - name: Agents
  - name: CallResults
  - name: Calls
  - name: Chats
  - name: CustomerData
  - name: Mcp
  - name: Media
  - name: Misc
  - name: PronunciationDictionaries
  - name: Providers
  - name: SipAliases
  - name: SipCredentials
  - name: SipPhoneNumbers
  - name: TextChat
  - name: TwilioProvider
  - name: Voice
  - name: WebhookTest
  - name: WebIntegrations
  - name: WebSocket
    description: WebSocket endpoints for real-time communication
paths:
  /api/v1/sip-phone-numbers:
    get:
      tags:
        - SipPhoneNumbers
      summary: List phone numbers
      description: >-
        Retrieves all SIP phone numbers for your organization with support for
        pagination and filtering.

        Filter by phone number, linked agent, or unlinked status.
      parameters:
        - name: phoneNumber
          in: query
          description: Search by phone number or display name (partial match)
          schema:
            type: string
        - name: skip
          in: query
          description: Number of items to skip
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
        - name: take
          in: query
          description: Number of items to return
          schema:
            maximum: 1000
            minimum: 1
            type: integer
            format: int32
            default: 20
        - name: linkedAgentId
          in: query
          description: Filter by linked agent
          schema:
            type: string
        - name: unlinkedOnly
          in: query
          description: Show only unlinked numbers
          schema:
            type: boolean
            default: false
        - name: providerId
          in: query
          description: >-
            Filter by provider. Returns only phone numbers managed by this
            provider.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Returns phone numbers successfully
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SipPhoneNumberResponseDtoPaginatedResponse
        '400':
          description: Invalid pagination parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Authentication failed or API key is missing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Server error occurred while retrieving phone numbers
components:
  schemas:
    SipPhoneNumberResponseDtoPaginatedResponse:
      required:
        - items
        - skip
        - take
        - totalCount
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SipPhoneNumberResponseDto'
          description: >-
            Items in the current page. Contains the subset of results for this
            page based on the Skip and Take parameters.
        totalCount:
          type: integer
          description: >-
            Total number of items available across all pages. Use this to
            calculate the total number of pages and build pagination controls.
            Represents the complete result set size regardless of pagination.
          format: int32
        skip:
          type: integer
          description: >-
            Number of items skipped from the beginning of the result set to
            reach this page. For example, Skip=20 with Take=10 returns items
            21-30. Use this to understand the current position in the overall
            result set.
          format: int32
        take:
          type: integer
          description: >-
            Maximum number of items included in this page. Indicates the
            requested page size. The actual Items count may be less than Take on
            the last page or when fewer results are available.
          format: int32
      additionalProperties: false
      description: >-
        Generic paginated response containing a subset of items along with
        pagination metadata. Enables efficient navigation through large datasets
        by returning data in manageable pages rather than loading all results at
        once.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    SipPhoneNumberResponseDto:
      required:
        - createdTime
        - credentialsId
        - id
        - lastUpdateTime
        - orgId
        - phoneNumber
        - registrationStatus
      type: object
      properties:
        id:
          type: string
          description: >-
            Unique identifier for this phone number configuration. Use this ID
            when referencing the number in agent configurations or API calls.
          format: uuid
        orgId:
          minLength: 1
          type: string
          description: >-
            Organization that owns this phone number. Used for access control
            and resource isolation.
        phoneNumber:
          minLength: 1
          type: string
          description: Phone number configured for outbound calling or inbound routing.
        credentialsId:
          type: string
          description: >-
            SIP credentials used by this phone number. References the trunk
            configuration that handles authentication and routing for calls.
          format: uuid
        description:
          type: string
          description: >-
            Human-readable description of this phone number. Helps document the
            number's purpose or usage.
          nullable: true
        displayName:
          type: string
          description: >-
            Display name shown in caller ID when making outbound calls with this
            number. Helps recipients identify the caller.
          nullable: true
        registration:
          type: boolean
          description: >-
            Whether SIP registration is performed for this phone number. Some
            SIP providers require registration before making calls. Indicates if
            registration is enabled for this configuration.
        providerId:
          type: string
          description: >-
            Reference to the VoIP provider that manages this phone number.
            Present only for provider-imported phone numbers. When present, the
            provider handles phone number lifecycle and trunk configuration.
          format: uuid
          nullable: true
        incomingCallsAgentId:
          type: string
          description: >-
            Agent that handles inbound calls to this phone number. When
            specified, incoming calls automatically route to this agent. When
            not set, inbound calls to this number are not answered.
          nullable: true
        createdTime:
          type: string
          description: >-
            Timestamp when this phone number configuration was originally
            created.
          format: date-time
        lastUpdateTime:
          type: string
          description: >-
            Timestamp when this phone number configuration was last modified.
            Updates when settings like DisplayName, Registration, or
            IncomingCallsAgentId change.
          format: date-time
        registrationStatus:
          allOf:
            - $ref: '#/components/schemas/SIPRegistrationStatusDTO'
          description: >-
            Current SIP registration status for this phone number. Indicates
            whether the number is successfully registered with the SIP provider
            and able to receive inbound calls.
      additionalProperties: false
      description: >-
        SIP phone number configuration including associated credentials, caller
        ID settings, inbound routing, and registration status. Contains all
        information needed to use this number for making and receiving calls.
    SIPRegistrationStatusDTO:
      type: object
      properties:
        state:
          allOf:
            - $ref: '#/components/schemas/RegistartionState'
          description: The current registration state.
        errorDescription:
          type: string
          description: Human-readable error description for failed registrations.
          nullable: true
        sipResponseMessage:
          type: string
          description: Full SIP response message for failed registrations.
          nullable: true
        lastUpdated:
          type: string
          description: When the status was last updated.
          format: date-time
        expiresAt:
          type: string
          description: >-
            When the registration expires. Null for failed or disabled
            registrations.
          format: date-time
          nullable: true
      additionalProperties: false
    RegistartionState:
      enum:
        - Disabled
        - InProgress
        - Succeeded
        - InProgressWithAuth
        - Initialized
        - Unknown
        - Failed
      type: string
      description: Represents the state of a SIP registration.

````