v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
numbers

Find 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.

get/numbers/leases

Query parameters

limitinteger

To set the maximum number of records to return in a paged list response. The default is 100

offsetinteger

Offset to the start of a given page. The default is 0. Check pagination page for more information about pagination in CallFire API.

prefixstring

A 4-7 digit prefix

citystring

A city name

statestring

A two-letter state code. Example: CA, IL, etc.

zipcodestring

A five-digit Zipcode

labelNamestring

A label name

tollFreeboolean

~

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

Response

successful operation

limitinteger

A maximum number of returned items. If items.size() < limit assume no more items

offsetinteger

An offset from a start of paging source

totalCountinteger

Total count of available results. -1 if unknown