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

# Numbers Inventory

> Retrieve a paginated list of all phone numbers currently provisioned in your account. Filter by number type, capabilities, and status. Includes detailed information about each number's configuration and services.

**What this does:** Returns a paginated list of all provisioned numbers on the account. Each record includes the phone number, `NID-`, capabilities, assigned routes, subscriber, and status. Use this to audit your number pool or find a specific number's ID.

**Next steps:**
- Get details for a specific number — `GET /v1.0/numbers`
- Update a number — `POST /v1.0/numbers/update`



## OpenAPI

````yaml /api-reference/openapi.json get /v1.0/numbers/inventory
openapi: 3.0.3
info:
  title: mPaaS Core APIs
  version: 1.0.8
  description: >-
    The Telegent mPaaS (Mobile Platform as a Service) API gives you full
    programmatic control over mobile phone numbers, messaging, voice routing,
    subscribers, and account management. Use these APIs to provision MVNO and
    IoT numbers, send and receive SMS/MMS, configure intelligent call routing,
    manage subscriber accounts, and apply AI Guardian controls. All requests
    require a Bearer token obtained from the Authentication endpoint. For
    support, visit https://support.telegent.com/support/home
  contact:
    name: Support
    email: support@telegent.com
  termsOfService: https://telegent.com/terms
  license:
    name: Use under LICX
    url: https://telegent.com/license
servers:
  - url: https://api.telegent.com
security:
  - BearerAuth: []
tags:
  - name: OAuth2
  - name: AI Guardian
  - name: Accounts
  - name: Distributors
  - name: Message
  - name: Numbers
  - name: Voicemail
  - name: Packages
  - name: Products
  - name: Schedules
  - name: Services
  - name: Sims
  - name: Subscribers
  - name: Subscriptions
  - name: Voice
  - name: Workgroups
paths:
  /v1.0/numbers/inventory:
    get:
      tags:
        - Numbers
      summary: Numbers Inventory
      description: >-
        Retrieve a paginated list of all phone numbers currently provisioned in
        your account. Filter by number type, capabilities, and status. Includes
        detailed information about each number's configuration and services.


        **What this does:** Returns a paginated list of all provisioned numbers
        on the account. Each record includes the phone number, `NID-`,
        capabilities, assigned routes, subscriber, and status. Use this to audit
        your number pool or find a specific number's ID.


        **Next steps:**

        - Get details for a specific number — `GET /v1.0/numbers`

        - Update a number — `POST /v1.0/numbers/update`
      parameters:
        - name: PageNumber
          in: query
          required: false
          schema:
            type: string
          description: Page number for paginated results (starts at 1)
        - name: Filter
          in: query
          description: Filter string
          schema:
            type: string
        - name: TotalNumbersRequested
          in: query
          description: TotalNumbersRequested int
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Numbers Inventory
          content:
            application/json:
              schema:
                type: object
              examples:
                example:
                  value:
                    AccountId: AID-ab12345-2725-45a1-bd5e-526ed19799xx
                    TotalResults: 346
                    PageNumber: 1
                    Filter: Active
                    PhoneNumbers:
                      - Number: '+18015555555'
                        Tnid: TNID-9772956561858
                        OrderId: TNOID-ddbaad7c-38c8-4cb4-bf0d-87ed9064f021
                        NumberType: mobile
                        MessageEnabled: true
                        MessageType: p2p
                        Classification: MVNO
                        VoiceEnabled: true
                        MessageRouteId: MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee
                        VoiceRouteId: CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe
                        Status: Active
                        OriginalDatePurchased: 02/05/2023
                        AssignedSubscriberId: TSUID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b8d
                        Iccid: '8901240397190556232'
                        Cnam: ABC Corp
                        QrActivationLink: https://api.telegent.com/qr-activation-link
                        SwapsRemaining: 1
                        NextSwapResetDate: '2025-12-04T22:09:41.56'
                        ProductType: Sms+Data+Voice
                        PortOutPin: '1234'
                      - Number: '+18015555556'
                        Tnid: TNID-8772956561858
                        OrderId: TNOID-ddbaad7c-38c8-4cb4-bf0d-87ed9064f021
                        NumberType: mobile
                        MessageEnabled: 'true'
                        MessageType: a2p
                        Classification: MVNO
                        VoiceEnabled: 'true'
                        MessageRouteId: MRID-73af1e73-d7b3-4696-bdd9-5b407d9e99ee
                        VoiceRouteId: CRID-4dec6beb-3985-444b-8c06-8baa5jjvawe
                        Status: Active
                        OriginalDatePurchased: 02/05/2023
                        AssignedSubscriberId: SID-d7b3-4696-bdd9-5b407d9e99ee-3985-444b7d
                        Iccid: '8901240397190555232'
                        Cnam: ABC Corp
                        QrActivationLink: https://api.telegent.com/qr-activation-link
                        SwapsRemaining: 2
                        NextSwapResetDate: '2025-12-04T22:09:41.56'
                        ProductType: Sms+Data
                        PortOutPin: '5678'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/BadRequest_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest_Result'
              examples:
                example:
                  value:
                    StatusCode: 400
                    Message: >-
                      Bad request: one or more required fields are missing or
                      contain an invalid value.
            text/json:
              schema:
                $ref: '#/components/schemas/BadRequest_Result'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Unauthorized_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized_Result'
              examples:
                example:
                  value:
                    StatusCode: 401
                    Message: >-
                      Unauthorized: Bearer token is missing, expired, or
                      invalid. Re-authenticate via POST /v1.0/oauth2/tokens.
            text/json:
              schema:
                $ref: '#/components/schemas/Unauthorized_Result'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Forbidden_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden_Result'
              examples:
                example:
                  value:
                    StatusCode: 403
                    Message: >-
                      Forbidden: your token does not have permission to access
                      this resource. Check the ApiEndpoint scope.
            text/json:
              schema:
                $ref: '#/components/schemas/Forbidden_Result'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/NotFound_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound_Result'
              examples:
                example:
                  value:
                    StatusCode: 404
                    Message: >-
                      Not found: the requested resource does not exist or
                      belongs to a different account.
            text/json:
              schema:
                $ref: '#/components/schemas/NotFound_Result'
        '405':
          description: Method Not Allowed
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/MethodNotAllowed_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowed_Result'
              examples:
                example:
                  value:
                    StatusCode: 405
                    Message: >-
                      Method not allowed: verify the HTTP method required for
                      this endpoint.
            text/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowed_Result'
        '408':
          description: Request Timeout
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RequestTimeout_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimeout_Result'
              examples:
                example:
                  value:
                    StatusCode: 408
                    Message: >-
                      Request timeout: the server did not receive a complete
                      request within the allowed time. Retry with exponential
                      backoff.
            text/json:
              schema:
                $ref: '#/components/schemas/RequestTimeout_Result'
        '429':
          description: Too Many Requests
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/TooManyRequests_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests_Result'
              examples:
                example:
                  value:
                    StatusCode: 429
                    Message: >-
                      Too many requests: rate limit exceeded. Slow your request
                      cadence and retry after a short delay.
            text/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests_Result'
        '500':
          description: Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/InternalServerError_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError_Result'
              examples:
                example:
                  value:
                    StatusCode: 500
                    Message: >-
                      Internal server error: an unexpected error occurred. If
                      the problem persists contact support@telegent.com.
            text/json:
              schema:
                $ref: '#/components/schemas/InternalServerError_Result'
        '503':
          description: Service Unavailable
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceUnavailable_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailable_Result'
              examples:
                example:
                  value:
                    StatusCode: 503
                    Message: >-
                      Service unavailable: the API is temporarily unavailable.
                      Retry after a short delay.
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailable_Result'
        '504':
          description: Gateway Timeout
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GatewayTimeout_Result'
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeout_Result'
              examples:
                example:
                  value:
                    StatusCode: 504
                    Message: >-
                      Gateway timeout: an upstream service did not respond in
                      time. Retry with exponential backoff.
            text/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeout_Result'
      x-codeSamples:
        - lang: cURL
          source: >-
            curl -X GET
            'https://api.telegent.com/v1.0/numbers/inventory?PageNumber=1' \
              -H 'Authorization: Bearer YOUR_TOKEN'
components:
  schemas:
    BadRequest_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    Unauthorized_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    Forbidden_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    NotFound_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    MethodNotAllowed_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    RequestTimeout_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    TooManyRequests_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    InternalServerError_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    ServiceUnavailable_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false
    GatewayTimeout_Result:
      required:
        - StatusCode
      type: object
      properties:
        StatusCode:
          type: integer
          format: int32
        Message:
          type: string
          nullable: true
      additionalProperties: false

````