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

# List the numbers

`GET /numbers`

## Request

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

The phone numbers of the project, oldest first. Released numbers are left out.

## Response `200`

The numbers.

- NumberList
  - `data` Number[], required
    - `id` string, uuid, required: The id of the number. Use it for the call plan.
    - `e164` string, required: The number in E.164, like +447700900123.
    - `type` string, required: national (non-geographic), geographic (with an area code), mobile or tollfree.
    - `status` string, required: pending (the registration is with the carrier, usually active within one business day), active or porting.
    - `created_at` string, date-time, required: When the number was added to the project.
    - `test` boolean, required: true for a test number (test mode), from the range +447700900000 to +447700900999. It can never be called for real.

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

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