---
title: "List virtual numbers"
method: GET
path: "/numbers"
tags: ["numbers"]
---

# List virtual numbers

`GET /numbers`

## Request

- Base URL: `https://api.voixcall.com/v1`
- URL: `https://api.voixcall.com/v1/numbers`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://api.voixcall.com/oauth/authorize`, token URL `https://api.voixcall.com/oauth/token`, scopes: `numbers:read`)
  - HTTP bearer

Virtual numbers on the personal account, newest first; released numbers are excluded and organization numbers never appear. Test keys get an empty list. Requires numbers:read.

## Query parameters

- `limit` string: Page size, 1 to 100. Default 10.
- `starting_after` string: Return objects after this id (older).
- `ending_before` string: Return objects before this id (newer).

## Response `200`

OK

- ListNumber
  - `data` Number[], nullable, required
    - `capabilities` string[], nullable, required: voice, sms, mms as the provider reports them.
    - `country_code` string, required
    - `id` string, required
    - `livemode` boolean, required
    - `messages_opt_in` boolean, required: Whether the owner opted this number in to message reads by connected apps and API keys (Settings → Connected apps). Read them with GET /v1/messages.
    - `object` 'number', required: Always "number".
    - `phone_number` string, required: E.164.
    - `renewal_at` string, date-time, nullable, required: Next renewal, or the end of the grace period while in grace_period.
    - `status` 'active' | 'grace_period' | 'pending_deactivation', required: grace_period: renewal payment failed; the number is kept until renewal_at.
  - `has_more` boolean, required: Whether more objects exist beyond this page in the direction of travel.
  - `object` 'list', required: Always "list".

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/voixcall/apis/voixcall-api.md) · [All operations](https://skmtc.dev/voixcall/apis/voixcall-api/llms.txt) · [OpenAPI document](https://skmtc.dev/voixcall/apis/voixcall-api/revisions/9aac329ff0f5?raw)