---
title: "Find leases"
method: GET
path: "/numbers/leases"
tags: ["numbers"]
---

# Find leases

`GET /numbers/leases`

Searches for all numbers leased by account user. This API is useful for finding all numbers currently owned by the user. Returns a paged list of number leases.

## Query parameters

- `limit` integer
- `offset` integer
- `prefix` string
- `city` string
- `state` string
- `zipcode` string
- `labelName` string
- `tollFree` boolean
- `fields` string

## Response `200`

successful operation

- NumberLeasePage — ~
  - `items` object[] — A list of returned items
    - `number` string — A phone number in E.164 format (11-digit). Example: 12132000384
    - `sendEmailOnCreate` boolean — ~
    - `nationalFormat` string — Formatted number with a country code
    - `tollFree` boolean — A toll-free number
    - `region` Region — Every local number associated with a region. You can query regions to use them in subsequent purchase requests
      - `prefix` string — A country prefix of a region. 4-7 digit
      - `city` string — A city of a region
      - `state` string — A two-letter state code of region
      - `zipcode` string — A five-digit zip code of a region
      - `regionCode` string — ~
      - `population` integer — ~
      - `country` string — A country of a region
      - `latitude` number, float — A latitude of a region
      - `longitude` number, float — A longitude of a region
      - `timeZone` string — A timezone of a region
    - `leaseBegin` integer — A date and time of a lease start. Timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000
    - `leaseEnd` integer — A data and time of a lease finish. Timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000
    - `autoRenew` boolean — Enables the auto renewal of number lease at end of each billing cycle
    - `status` 'PENDING' | 'ACTIVE' | 'RELEASED' | 'UNAVAILABLE' — A lease status. Available values: PENDING, ACTIVE, RELEASED, UNAVAILABLE
    - `callFeatureStatus` 'UNSUPPORTED' | 'PENDING' | 'DISABLED' | 'ENABLED' — A status of a call feature. Available values: DISABLED, ENABLED
    - `textFeatureStatus` 'UNSUPPORTED' | 'PENDING' | 'DISABLED' | 'ENABLED' — A status of a text feature. Available values: DISABLED, ENABLED
    - `labels` string[] — ~
    - `type` 'PLAN' | 'EXTRA' — ~
  - `limit` integer — A maximum number of returned items. If items.size() < limit assume no more items
  - `offset` integer — An offset from a start of paging source
  - `totalCount` integer — Total count of available results. -1 if unknown

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/callfire/apis/callfire-api-documentation.md) · [All operations](https://skmtc.net/callfire/apis/callfire-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/callfire/callfire-api-documentation/versions/9f6fb501bc03/schema)