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

# Find keyword leases

`GET /keywords/leases`

Searches for all keywords owned by user. A keyword lease is the ownership information involving a keyword

## Query parameters

- `limit` integer
- `offset` integer
- `filter` string
- `labelName` string
- `fields` string

## Response `200`

successful operation

- KeywordLeasePage — ~
  - `items` object[] — A list of returned items
    - `shortCode` string — A short code assigned to keyword. Example: 67076 (Deprecated - please use number instead)
    - `number` string — A number assigned to keyword. Example: 12132212344
    - `keyword` string — A text used as a keyword
    - `leaseBegin` integer — A time of a lease timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT
    - `leaseEnd` integer — A date and time when the keyword lease is finishes. Timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000
    - `autoRenew` boolean — Enables the auto renewal of a keyword lease at the end of each billing cycle
    - `doubleOptInEnabled` boolean — Enable/disable double opt in feature
    - `optInConfirmationMessage` string — Opt in confirmation message
    - `contactListId` integer — Existing contact list ID
    - `status` 'PENDING' | 'ACTIVE' | 'RELEASED' | 'UNAVAILABLE' — A lease status. Available values: PENDING, ACTIVE, RELEASED, UNAVAILABLE
    - `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.dev/callfire/apis/callfire-api-documentation.md) · [All operations](https://skmtc.dev/callfire/apis/callfire-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/callfire/callfire-api-documentation/revisions/9f6fb501bc03/schema)