14666f4db0f8
Search across multiple entity types
Returns a list of matching results across entity types based on the provided search term.
By default, results are returned from all entity types (jobs, leads, clients, invoices) up to the specified limit per type.
Use the type parameter to restrict results to a single entity type. Requesting type=lead requires the Leads add-on to be enabled on the account.
Results are ranked by relevance score. The entityId field is an ID that can be used with other API endpoints.
Query parameters
Search term matched against name, phone, email, address, serial numbers, and custom fields across entity types.
Restrict results to a single entity type. Omit to search across all types.
- job — returns only jobs (excludes leads)
- lead — returns only leads (requires Leads add-on)
- client — returns only clients
- invoice — returns only invoices
Maximum number of results to return per entity type. Defaults to 5, maximum 15.
Headers
Bearer Token
Response
Search results grouped with total count and result list.
Example response
{
"limit": 5,
"totalResults": 10,
"data": [
{
"entityType": "job",
"entityId": "JOB-LwqGJnRwvZPaNe5E",
"uuid": "GD87TS",
"serialId": 1042,
"name": "Fix leaking pipe",
"status": "pending",
"date": "2026-04-28 09:00:00",
"totalPrice": 250,
"amountDue": 100,
"companyName": "Acme Corp",
"email": "client@example.com",
"primaryPhone": "6195551234",
"fullAddress": "123 Main St, San Diego, CA 92101",
"clientInfo": {
"serialId": 1023,
"fullName": "John Doe",
"companyName": "Sample Company name",
"email": "client@workiz.com",
"primaryPhone": "6195555555",
"fullAddress": "123 Main St, New York, NY 10001"
}
}
]
}