Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

TFU Live agent id. Never use an ordinary provider agent id.

Query Parameters

locationId
string
required

Sub-account belonging to the authenticated agency and any narrower credential location binding.

campaignId
string

When more than one campaign uses this rep, the one whose calling line to use.

Pattern: ^[a-zA-Z0-9_-]{1,100}$
countryCode
string

Two letters, such as US, CA or GB. Get TFU Live agent numbers lists where numbers are sold.

Pattern: ^[A-Za-z]{2}$
areaCode
string
Pattern: ^\d{3}$
place
string

A town, or a state or province.

Maximum string length: 100
tollFree
boolean
widen
boolean

True (or 1): none where asked widens by itself. Omit to search only where asked.

Response

Successful response.

success
any
required
candidates
object[]
required
Maximum array length: 10
price
object
required
search
object | null

What was finally searched.

widened
object

Present when none were found where asked and the search widened by itself (widen).

{key}
any