Skip to navigation
HINDSITE APIwork_order_templates

Get Work Order Templates

View as Markdown
Lists the work order templates the caller can access, ten per page and active ones by default, where admins see every template in the organisation and other users see templates shared with their locations or groups.

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

  1. Request API credentials from HINDSITE support to receive your client_id and client_secret

  2. Make a POST request to obtain an access token:

POST https://app.hindsiteind.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
  1. The response will contain your access token:
{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}
  1. Include the token in subsequent API requests:
Authorization: Bearer your_access_token_here

Query parameters

searchstringOptional
Only return templates whose title matches this text.
location_ids[]list of stringsOptional

Only return templates shared with these locations. Repeat the parameter to pass several IDs, e.g. location_ids[]=A&location_ids[]=B.

archivedbooleanOptional

Pass true to list archived templates instead of active ones.

pageintegerOptionalDefaults to 1
Page number, starting at 1. Each page holds up to 10 templates.

Response

get WorkOrderTemplate(s)

resultslist of objectsOptional
next_pageintegerOptional
Next page number, or null if no more pages

Errors

400
Bad Request Error