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

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/search/{objectType}.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token

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"
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.