Search
Find leads, accounts, sequence templates and tasks by name in one call.
GET
/
v1
/
search
Search
curl --request GET \
--url https://api.topo.io/v1/search \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.topo.io/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "<string>",
"type": "lead",
"title": "<string>",
"subtitle": "<string>",
"url": "<string>"
}
]
}Find leads, accounts, sequence templates and tasks by name in one call.
Each match carries a typed id
GET /v1/fetch turns back into the full
record, so a name is enough to reach any of them without knowing which
endpoint owns it. Kinds the key may not read are dropped from the search
rather than rejected, so a contacts-only key searching everything still
gets its leads.Authorizations
Bearer API key issued from Settings → Developers.
Query Parameters
Text to match against the name of workspace records.
Minimum string length:
1Restrict the search to these kinds of record. Omit to search all of them.
Available options:
lead, account, sequence_template, task Response
200 - application/json
Successful Response
Best matches per kind of record, capped per kind.
Hide child attributes
Hide child attributes
Typed id of the match, in the form <type>:<uuid>. Pass it to GET /v1/fetch.
Kind of record matched.
Available options:
lead, account, sequence_template, task Display name of the record.
Secondary line describing the record, when there is one.
Deep link to the record in the Topo app, when it has a page.
Was this page helpful?
⌘I
Search
curl --request GET \
--url https://api.topo.io/v1/search \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.topo.io/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "<string>",
"type": "lead",
"title": "<string>",
"subtitle": "<string>",
"url": "<string>"
}
]
}