Skip to navigation
HINDSITE APIinstruction_suggestions

Get Instruction Suggestions Id

View as Markdown
Returns one instruction suggestion the caller can see, with its author, notes, attachments and the instruction and step it was raised on.

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

Response

get InstructionSuggestion
idstringOptional
ULID
titlestringOptional
descriptionstring or nullOptional
completedbooleanOptional
True once the suggestion has been reviewed.
mentionablebooleanOptional
Whether users can be mentioned in notes on this suggestion. Currently always true.
user_idstringOptional
ULID of the user who raised the suggestion.
instruction_step_uuidstringOptional

The step’s step_uuid, which stays the same across revisions. Not an instruction step ID.

created_atdatetimeOptional
updated_atdatetimeOptional
instruction_labelstringOptional

Title of the instruction, or of the step group prefixed with its label, the suggestion was raised on. Present only on GET /api/v2/instruction_suggestions/{id}.

instruction_step_labelstring or nullOptional

The step’s title, falling back to its description. Present only on GET /api/v2/instruction_suggestions/{id}.

userobjectOptional

The user who raised the suggestion. Present on the list and GET /api/v2/instruction_suggestions/{id}.

noteslist of objectsOptional

Present only on GET /api/v2/instruction_suggestions/{id}.

attachmentslist of objectsOptional

Files attached when the suggestion was raised. Present only on GET /api/v2/instruction_suggestions/{id}.

Errors

402
Payment Required Error
404
Not Found Error