v1
latestOpenAPI 3.1.02026-08-0420819698.7 KBRoutes
Tasks
Instructions
Get Task Instruction by ID
This request retrieves a single Task Instruction by its instructionID.
Path Parameters:
- instructionID (required): The ID of the instruction to retrieve
Return data description:
Returns a single instruction object with the following properties:
| Property | Description |
|---|---|
| instructionID | The unique identifier for this instruction |
| taskID | The ID of the task this instruction belongs to |
| parentInstructionID | This is the instructionID of the Instruction's parent. If this value is 0 then this Instruction does not have a parent. |
| instruction | The text that guides a User on what to do on this Instruction. |
| type | The type of the Instruction. See the request Post New Task Instruction to see a list of possible types and their meaning. |
| instructionFiles | Array of objects that have a file name and a link you can use to download that file. All links are only valid for 15 minutes, a new call will generate a new link. |
| response | This field is the 'response' of an instruction i.e. what a user filled out when completing this instruction. |
Error Responses:
- 404: Instruction not found
get/v2/tasks/instructions/{instructionID}
Response
Success Response