Search across jobs, leads, contacts and more

Searches the company's records for the text in q and returns the matches grouped by type:
jobs, leads, contacts, addresses, agreements (estimates, proposals and contracts) and
estimates (estimates only). counts gives the number of results in each group and in total.

  • Each word matches the start of words in the record, so smi finds "Smith", and a record
    matching any of the words is returned.
  • Phone numbers match on their digits, whatever formatting you use.
  • Each group returns at most 50 results, newest first (contacts are sorted by name). Narrow the
    query if you hit the limit; there is no pagination.

Results only include records the token's role can see. A sales rep, for example, only gets their
own and their team's jobs and leads. A blank q returns empty groups.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The text to search for, such as a name, phone number, email address, street address or job number.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json