---
title: "Get a phone number by ID"
method: GET
path: "/v1/phone-numbers/{id}"
tags: ["Phone Numbers"]
---

# Get a phone number by ID

`GET /v1/phone-numbers/{id}`

## Request

- Base URL: `https://api.honkio.ca`
- URL: `https://api.honkio.ca/v1/phone-numbers/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Requires `phone_numbers:r`.

## Path parameters

- `id` string, required

## Response `200`

The number, released ones included.

- PhoneNumber: A phone number provisioned on the account.
  - `id` string, required
  - `phone_number` string, required: E.164
  - `area_code` string, required
  - `region` string, nullable, required: Province or territory, when the area code maps to one.
  - `capabilities` string[], required
  - `status` 'ACTIVE' | 'SUSPENDED' | 'RELEASING' | 'RELEASED', required
  - `monthly_cost_cents` integer, required: Recurring rent in CAD cents.
  - `provisioned_at` string, date-time, required
  - `released_at` string, date-time, nullable, required
  - `number_type` 'local' | 'toll_free', required: Toll-free numbers (833, 844, 855, 866, 877, 888) need an approved toll-free verification before they can send SMS.
  - `toll_free_verification` object, nullable, required: The newest toll-free verification application for this number, cancelled ones aside. Null for a local number or a toll-free number never applied for.
    - `id` string, required: tfv_…
    - `status` 'DRAFT' | 'AWAITING_PAYMENT' | 'IN_REVIEW' | 'CHANGES_REQUESTED' | 'SUBMITTED' | 'APPROVED' | 'REJECTED' | 'DECLINED', required: The number sends SMS once this is APPROVED.

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: The API key lacks the permission this operation requires, or the account is suspended or closed.
- `404`: NOT_FOUND: no such resource on this account.
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.

---

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