latestOpenAPI 3.1.02026-08-18104219248.1 KB

ad6ac1d13526

search

Search

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.

get/v1/search

Query parameters

querystring required

Text to match against the name of workspace records.

Text to match against the name of workspace records.

typesstring[] nullable

Restrict the search to these kinds of record. Omit to search all of them.

Restrict the search to these kinds of record. Omit to search all of them.

Response

Successful Response