Skip to navigation
HINDSITE APIreviews

Post Work Order Tasks Id External Reviewers

View as Markdown

Emails a request to review a completed work order task to an external reviewer, either an existing external user by user_id or a new one registered from name and email; only admins, the parent work order’s assigned managers and leads, and location managers who did not contribute to the task’s form may call it, and only when external reviews are enabled for the organisation.

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

Path parameters

idstringRequired

Request

This endpoint expects an object.
user_idstringOptional

ULID of an existing active external user in the organisation. When given, name and email are ignored.

namestringOptional

Name for a new external user; required when user_id is not given

emailstringOptional

Email for a new external user; required when user_id is not given

Response

The requested external reviewer
idstringOptional
ULID
userobjectOptional

The reviewer, including last_active_at and archived

reviewable_idstringOptional
ULID of the work order or work order task under review
reviewable_typeenumOptional
Allowed values:
statusenumOptional

pending while awaiting a response (including after a reminder), approved or rejected once they respond, commented for someone who only commented without being asked to review

Allowed values:
requested_atdatetime or nullOptional

When the review request was last emailed (ISO 8601); null if no request was emailed, such as someone who reviewed without being asked

stalebooleanOptional
true when the reviewer's latest approval or rejection is older than the latest change to the work
externalbooleanOptional

true for an external (non-member) reviewer

remindablebooleanOptional

true when the caller can send this reviewer a reminder: they are not the caller, their access is not revoked, and they can receive email

removablebooleanOptional
true while the reviewer has not reviewed, so can be removed
revocablebooleanOptional
true for an external reviewer who has reviewed and whose access is not yet revoked
revocationobject or nullOptional
null unless the reviewer's access has been revoked
reviewslist of objectsOptional
Oldest first
created_atlongOptional

Unix timestamp (seconds since epoch)

updated_atlongOptional

Unix timestamp (seconds since epoch)

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error