---
title: "Search phone numbers"
method: GET
path: "/numbers"
tags: ["Phone Numbers"]
---

# Search phone numbers

`GET /numbers`

Search for your phone numbers.

## Query parameters

- `sid` string — Short ID
- `class` 'gold' | 'classic' — Number class. "gold" is for premium (rare) numbers, "classic" is for regular numbers.
- `type` 'geographic' | 'mobile' | 'non-geographic' | 'personal' | 'platform' | 'sharedrevenue' | 'sms-only' | 'special' | 'tollfree' | 'verified' — Type of number
- `contains` string
- `detached` true
- `sort` 'assigned' | 'e164'
- `order` 'asc' | 'desc'
- `offset` integer — Offset index (zero-based)
- `limit` integer — Limit search results

## Response `200`

Search results

- NumberSearchResult — Numbers search result
  - `offset` integer, required — Offset index (zero-based)
  - `total` integer, required
  - `hasMore` boolean, required — Whether there are more results available
  - `hits` Number[], required
    - `e164` string, required — A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"
    - `class` 'gold' | 'classic', required — Number class. "gold" is for premium (rare) numbers, "classic" is for regular numbers.
    - `type` 'geographic' | 'mobile' | 'non-geographic' | 'personal' | 'platform' | 'sharedrevenue' | 'sms-only' | 'special' | 'tollfree' | 'verified', required — Type of number
    - `assigned` string, date-time, required — RFC 3339, section 5.6
    - `country` string, required — ISO 3166-1 alpha-2 country code
    - `scenario` ScenarioAssigned — Scenario assigned to number
      - `sid` string, required — Short ID
      - `name` string, required
      - `type` object, required
        - `name` string, required
        - `version` string, required
    - `compliance` object, required
      - `state` 'invalid' | 'active' | 'warning' | 'disabled', required
      - `blockedAfter` string, date-time — RFC 3339, section 5.6
    - `contract` object, required
      - `ends` string, date-time, required — RFC 3339, section 5.6
      - `renew` boolean, required
    - `pricing` NumberPricing, required — Number pricing schema
      - `increment` integer, required
      - `minduration` integer, required
      - `minute` string, required — Amount in cents
      - `mrc` string, required — Amount in cents
      - `nrc` string, required — Amount in cents
      - `setup` string, required — Amount in cents
    - `enduser` EndUserAssigned, required
      - `name` string, required
      - `address` object, required
        - `country` string, required — ISO 3166-1 alpha-2 country code
        - `city` string
      - `comment` string
      - `sid` string, required — Short ID
      - `type` 'self' | 'third-party', required — The type of end user. It can be either **self** (your company) or **third-party**. Any end user you create is considered as third-party.
      - `created` string, date-time, required — RFC 3339, section 5.6
      - `updated` string, date-time, required — RFC 3339, section 5.6
      - `deletable` boolean — Whether the end user can be deleted or not. Self end user cannot be deleted. Third party end users can be deleted if they are not associated with any phone number.
      - `freeze` object, required
        - `unfreeze` string, date-time — RFC 3339, section 5.6
        - `frozen` boolean, required
      - `compliance` object, required
        - `status` 'no-rules-required' | 'country-not-allowed' | 'missing-documents' | 'pending' | 'approved', required
        - `compliant` boolean, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `405` — Method Not Allowed
- `429` — Too Many Requests (rate limit exceeded)
- `500` — Internal Server Error

---

[API](https://skmtc.net/callr/apis/callr-rest-api-v2-0.md) · [All operations](https://skmtc.net/callr/apis/callr-rest-api-v2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/callr/callr-rest-api-v2-0/versions/76d36d004a8f/schema)