v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-211931021.7 MB
Search

Search within a specific object type

Performs a text search within a specific object type. Supported types: job, company, material, knowledgearticle, attachment, formresponse, asset, materialbundle

get/search/{objectType}.json

Path parameters

objectType'job' | 'company' | 'material' | 'knowledgearticle' | 'attachment' | 'formresponse' | 'asset' | 'materialbundle' required

Type of object to search

Query parameters

qstring required
Example:emergency repair

Search query string

limitinteger

Maximum number of results to return (max 100)

Response

Search results

querystring required

The search query that was used

objectTypestring required

The object type that was searched

countinteger required

Number of results returned

Example response

{
  "results": [
    {
      "type": "job"
    }
  ]
}