> ## 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/v1.0 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: application/json: schema: $ref: '#/components/schemas/BadRequest_Result' example: StatusCode: 400 Message: >- Bad request: one or more required fields are missing or contain an invalid value. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized_Result' example: StatusCode: 401 Message: >- Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens. '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Forbidden_Result' example: StatusCode: 403 Message: >- Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope. '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFound_Result' example: StatusCode: 404 Message: >- Not found: the requested resource does not exist or belongs to a different account. '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowed_Result' example: StatusCode: 405 Message: >- Method not allowed: verify the HTTP method required for this endpoint. '408': description: Request Timeout content: application/json: schema: $ref: '#/components/schemas/RequestTimeout_Result' example: StatusCode: 408 Message: >- Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff. '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/TooManyRequests_Result' example: StatusCode: 429 Message: >- Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay. '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError_Result' example: StatusCode: 500 Message: >- Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com. '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailable_Result' example: StatusCode: 503 Message: >- Service unavailable: the API is temporarily unavailable. Retry after a short delay. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/GatewayTimeout_Result' example: StatusCode: 504 Message: >- Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff. 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 example: 400 Message: type: string nullable: true example: >- Bad request: one or more required fields are missing or contain an invalid value. additionalProperties: false example: StatusCode: 400 Message: >- Bad request: one or more required fields are missing or contain an invalid value. Unauthorized_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 401 Message: type: string nullable: true example: 'Unauthorized: Bearer token is missing, expired, or invalid.' additionalProperties: false example: StatusCode: 401 Message: 'Unauthorized: Bearer token is missing, expired, or invalid.' Forbidden_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 403 Message: type: string nullable: true example: >- Forbidden: your token does not have permission to access this resource. additionalProperties: false example: StatusCode: 403 Message: >- Forbidden: your token does not have permission to access this resource. NotFound_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 404 Message: type: string nullable: true example: >- Not found: the requested resource does not exist or belongs to a different account. additionalProperties: false example: StatusCode: 404 Message: >- Not found: the requested resource does not exist or belongs to a different account. MethodNotAllowed_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 405 Message: type: string nullable: true example: >- Method not allowed: verify the HTTP method required for this endpoint. additionalProperties: false example: StatusCode: 405 Message: 'Method not allowed: verify the HTTP method required for this endpoint.' RequestTimeout_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 408 Message: type: string nullable: true example: >- Request timeout: the server did not receive a complete request in time. additionalProperties: false example: StatusCode: 408 Message: >- Request timeout: the server did not receive a complete request in time. TooManyRequests_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 429 Message: type: string nullable: true example: >- Too many requests: rate limit exceeded. Slow your request cadence and retry. additionalProperties: false example: StatusCode: 429 Message: >- Too many requests: rate limit exceeded. Slow your request cadence and retry. InternalServerError_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 500 Message: type: string nullable: true example: 'Internal server error: an unexpected error occurred.' additionalProperties: false example: StatusCode: 500 Message: 'Internal server error: an unexpected error occurred.' ServiceUnavailable_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 503 Message: type: string nullable: true example: 'Service unavailable: the API is temporarily unavailable.' additionalProperties: false example: StatusCode: 503 Message: 'Service unavailable: the API is temporarily unavailable.' GatewayTimeout_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 504 Message: type: string nullable: true example: 'Gateway timeout: an upstream service did not respond in time.' additionalProperties: false example: StatusCode: 504 Message: 'Gateway timeout: an upstream service did not respond in time.' ````