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

# Find lease configs

`GET /numbers/leases/configs`

Searches for all number lease configs for the user. Returns a paged list of NumberConfig

## Query parameters

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

## Response `200`

successful operation

- NumberConfigPage — ~
  - `items` object[] — A list of returned items
    - `textInboundConfig` TextInboundConfig — ~
      - `forwardEnabled` boolean — ~
      - `forwardNumber` string — ~
    - `number` string — Phone number in E.164 format (11-digit). Example: 12132000384
    - `configType` 'IVR' | 'TRACKING' — A type of config. Available values: TRACKING, IVR
    - `callTrackingConfig` CallTrackingConfig — Call tracking configuration allows you track incoming calls, analyze, respond to customers using sms or voice replies. For more information see [call tracking page](https://www.callfire.com/products/call-tracking)
      - `transferNumbers` string[] — List of phone numbers in E.164 format (11-digit) are used for transfer. Example: 12132000384
      - `screen` boolean — Screens the incoming calls
      - `recorded` boolean — Records all inbound calls
      - `voicemail` boolean — Enables voicemail if call is not transferred
      - `introSoundId` integer — An id of sound file, played if call is answered
      - `whisperSoundId` integer — An id of sound file, played if call is screened
      - `voicemailSoundId` integer — An id of sound file, played if voicemail is enabled and a call isn't transferred
      - `failedTransferSoundId` integer — An id of sound file, played if caller can not be connected to transfer number for any reason
      - `weeklySchedule` WeeklySchedule — Weekly schedule allows to schedule operations by day of week and time of the day
        - `startTimeOfDay` LocalTime — Represents a time part of a given date
          - `hour` integer — An hour of the day. Available values: 0-23
          - `minute` integer — The minutes. Available values: 0-59
          - `second` integer — The seconds. Available values: 0-59
          - `nano` integer — ~
        - `stopTimeOfDay` LocalTime — Represents a time part of a given date
          - `hour` integer — An hour of the day. Available values: 0-23
          - `minute` integer — The minutes. Available values: 0-59
          - `second` integer — The seconds. Available values: 0-59
          - `nano` integer — ~
        - `daysOfWeek` string[] — A scheduled days when operation will trigger
        - `timeZone` string — A user's timezone
      - `googleAnalytics` GoogleAnalytics — Google Analytics for Call Tracking
        - `domain` string — A domain name for analytics
        - `googleAccountId` string — An id of a Google account, example: UA-XXXXX-2X
        - `category` string — A category to group. For example: Sales or Support
        - `googleApiSecret` string — ~
    - `ivrInboundConfig` IvrInboundConfig — ~
      - `dialplanXml` string — ~
  - `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)