Skip to content
Hyperproof API
/
/
Add Task Proof

Tasks API (1.0)

Provides access to the tasks that are part of a Hyperproof organization.

Download OpenAPI description
tasks.openapi.json
tasks.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi
Hyperproof US
https://api.hyperproof.app/v1/tasks
Hyperproof Gov
https://api.hyperproofgov.app/v1/tasks
Hyperproof EU
https://api.hyperproof.eu/v1/tasks

Add Task

Request

POST /

Description

Creates a new task within an organization, initializing its details such as title, description, due dates, and assigned users.

Security
oauth2
Bodyapplication/json
titlestringrequired

The title of the task.

Example: "Submit the latest employee agreements"
targetObjectobject(ObjectReference)required
targetObject.​objectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
targetObject.​objectIdstring

The unique identifier of the referenced object.

targetObject.​parentIdstring

The unique identifier of the parent of the referenced object.

descriptionstring

The description of the task.

Example: "The latest employee agreements are needed for the upcoming audit."
assigneeIdstring(uuid)

The unique identifier of the user assigned to the task.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
prioritystring(Priority)

The priority level.

Enum"highest""high""medium""low""lowest"
dueDatestring(date-time)

The due date of the task (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
hasIntegrationboolean

Whether the task has an integration.

groupIdstring(uuid)

The unique identifier of the group assigned to the task.

curl -i -X POST \
  https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Submit the latest employee agreements",
    "targetObject": {
      "objectId": "23b802db-bad2-4f7a-b8d1-ac1177909992",
      "objectType": "control"
    },
    "description": "The latest employee agreements are needed for the upcoming audit.",
    "assigneeId": "ad21d858-c271-4c6d-8780-fecf6b16e534",
    "priority": "medium",
    "dueDate": "2020-12-17T20:00:00.0000000+00:00",
    "hasIntegration": false
  }'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier of the task.

Example: "ba50096d-bbfa-47af-94a7-092b0984cf35"
orgIdstring

The unique identifier of the organization the task belongs to.

Example: "4c05da3f-f076-461c-8105-80a07a42ab7f"
titlestring

The title of the task.

Example: "Submit the latest employee agreements"
descriptionstring

The description of the task.

Example: "The latest employee agreements are needed for the upcoming audit."
assigneeIdstring

The unique identifier of the user assigned to the task.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
targetIdstring

The unique identifier of the object that is the target of the task.

Example: "23b802db-bad2-4f7a-b8d1-ac1177909992"
targetTypestring

The object type of the target of the task.

Example: "control"
taskStatusIdstring

The unique identifier of the task status for the task.

Example: "e2303b2b-5ee4-4354-92de-dfacd1d33f09"
prioritystring(Priority)

The priority level.

Enum"highest""high""medium""low""lowest"
dueDatestring(date-time)

The due date of the task (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
createdOnstring(date-time)

The date and time the task was created (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
updatedOnstring(date-time)

The date and time the task was last updated (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
groupIdstring

The unique identifier of the group assigned to the task.

Example: "193ceec7-4911-11ef-8f90-8688bf62af58"
Response
application/json
{
  "id": "ba50096d-bbfa-47af-94a7-092b0984cf35",
  "orgId": "4c05da3f-f076-461c-8105-80a07a42ab7f",
  "title": "Submit the latest employee agreements",
  "description": "The latest employee agreements are needed for the upcoming audit.",
  "assigneeId": "ad21d858-c271-4c6d-8780-fecf6b16e534",
  "targetId": "23b802db-bad2-4f7a-b8d1-ac1177909992",
  "targetType": "control",
  "taskStatusId": "e2303b2b-5ee4-4354-92de-dfacd1d33f09",
  "priority": "medium",
  "dueDate": "2020-12-17T20:00:00.0000000+00:00",
  "createdOn": "2020-12-17T20:00:00.0000000+00:00",
  "updatedOn": "2020-12-17T20:00:00.0000000+00:00"
}

Get Task

Request

GET /{taskId}

Description

Retrieves detailed information about a specific task by its ID, including its attributes, status, assignments, and related activity.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task to retrieve.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier of the task.

Example: "ba50096d-bbfa-47af-94a7-092b0984cf35"
orgIdstring

The unique identifier of the organization the task belongs to.

Example: "4c05da3f-f076-461c-8105-80a07a42ab7f"
titlestring

The title of the task.

Example: "Submit the latest employee agreements"
descriptionstring

The description of the task.

Example: "The latest employee agreements are needed for the upcoming audit."
assigneeIdstring

The unique identifier of the user assigned to the task.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
targetIdstring

The unique identifier of the object that is the target of the task.

Example: "23b802db-bad2-4f7a-b8d1-ac1177909992"
targetTypestring

The object type of the target of the task.

Example: "control"
taskStatusIdstring

The unique identifier of the task status for the task.

Example: "e2303b2b-5ee4-4354-92de-dfacd1d33f09"
prioritystring(Priority)

The priority level.

Enum"highest""high""medium""low""lowest"
dueDatestring(date-time)

The due date of the task (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
createdOnstring(date-time)

The date and time the task was created (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
updatedOnstring(date-time)

The date and time the task was last updated (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
groupIdstring

The unique identifier of the group assigned to the task.

Example: "193ceec7-4911-11ef-8f90-8688bf62af58"
Response
application/json
{
  "id": "ba50096d-bbfa-47af-94a7-092b0984cf35",
  "orgId": "4c05da3f-f076-461c-8105-80a07a42ab7f",
  "title": "Submit the latest employee agreements",
  "description": "The latest employee agreements are needed for the upcoming audit.",
  "assigneeId": "ad21d858-c271-4c6d-8780-fecf6b16e534",
  "targetId": "23b802db-bad2-4f7a-b8d1-ac1177909992",
  "targetType": "control",
  "taskStatusId": "e2303b2b-5ee4-4354-92de-dfacd1d33f09",
  "priority": "medium",
  "dueDate": "2020-12-17T20:00:00.0000000+00:00",
  "createdOn": "2020-12-17T20:00:00.0000000+00:00",
  "updatedOn": "2020-12-17T20:00:00.0000000+00:00"
}

Update Task

Request

PATCH /{taskId}

Description

Updates an existing task with new values, modifying its attributes such as title, description, status, assignee, or due dates.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task to update.

Bodyapplication/json
titlestring

The title of the task.

Example: "Submit the latest employee agreements"
descriptionstring

The description of the task.

Example: "The latest employee agreements are needed for the upcoming audit."
assigneeIdstring(uuid)

The unique identifier of the user assigned to the task.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
targetIdstring(uuid)

The unique identifier of the object that is the target of the task.

Example: "23b802db-bad2-4f7a-b8d1-ac1177909992"
targetTypestring

The object type of the target of the task.

Example: "control"
taskStatusIdstring(uuid)

The unique identifier of the task status for the task.

Example: "e2303b2b-5ee4-4354-92de-dfacd1d33f09"
prioritystring(Priority)

The priority level.

Enum"highest""high""medium""low""lowest"
dueDatestring(date-time)

The due date of the task (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
groupIdstring(uuid)

The unique identifier of the group assigned to the task.

clearGroupIdboolean

Whether to clear the existing group identifier. GroupId must be empty.

curl -i -X PATCH \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Submit the latest employee agreements",
    "description": "The latest employee agreements are needed for the upcoming audit.",
    "assigneeId": "ad21d858-c271-4c6d-8780-fecf6b16e534",
    "targetId": "23b802db-bad2-4f7a-b8d1-ac1177909992",
    "targetType": "control",
    "taskStatusId": "e2303b2b-5ee4-4354-92de-dfacd1d33f09",
    "priority": "medium",
    "dueDate": "2020-12-17T20:00:00.0000000+00:00"
  }'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier of the task.

Example: "ba50096d-bbfa-47af-94a7-092b0984cf35"
orgIdstring

The unique identifier of the organization the task belongs to.

Example: "4c05da3f-f076-461c-8105-80a07a42ab7f"
titlestring

The title of the task.

Example: "Submit the latest employee agreements"
descriptionstring

The description of the task.

Example: "The latest employee agreements are needed for the upcoming audit."
assigneeIdstring

The unique identifier of the user assigned to the task.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
targetIdstring

The unique identifier of the object that is the target of the task.

Example: "23b802db-bad2-4f7a-b8d1-ac1177909992"
targetTypestring

The object type of the target of the task.

Example: "control"
taskStatusIdstring

The unique identifier of the task status for the task.

Example: "e2303b2b-5ee4-4354-92de-dfacd1d33f09"
prioritystring(Priority)

The priority level.

Enum"highest""high""medium""low""lowest"
dueDatestring(date-time)

The due date of the task (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
createdOnstring(date-time)

The date and time the task was created (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
updatedOnstring(date-time)

The date and time the task was last updated (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
groupIdstring

The unique identifier of the group assigned to the task.

Example: "193ceec7-4911-11ef-8f90-8688bf62af58"
Response
application/json
{
  "id": "ba50096d-bbfa-47af-94a7-092b0984cf35",
  "orgId": "4c05da3f-f076-461c-8105-80a07a42ab7f",
  "title": "Submit the latest employee agreements",
  "description": "The latest employee agreements are needed for the upcoming audit.",
  "assigneeId": "ad21d858-c271-4c6d-8780-fecf6b16e534",
  "targetId": "23b802db-bad2-4f7a-b8d1-ac1177909992",
  "targetType": "control",
  "taskStatusId": "e2303b2b-5ee4-4354-92de-dfacd1d33f09",
  "priority": "medium",
  "dueDate": "2020-12-17T20:00:00.0000000+00:00",
  "createdOn": "2020-12-17T20:00:00.0000000+00:00",
  "updatedOn": "2020-12-17T20:00:00.0000000+00:00"
}

Add Task Proof

Request

POST /{taskId}/proof

Description

Adds a proof item to a task, attaching supporting evidence and its associated metadata for tracking and review.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task.

Bodymultipart/form-data
proofstring(binary)required
hp-proof-owned-bystring
hp-proof-sourcestring
hp-proof-source-idstring
hp-proof-source-file-idstring
hp-proof-source-modified-onstring(date-time)
hp-proof-live-sync-enabledboolean
curl -i -X POST \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}/proof' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F proof=string \
  -F hp-proof-owned-by=string \
  -F hp-proof-source=string \
  -F hp-proof-source-id=string \
  -F hp-proof-source-file-id=string \
  -F hp-proof-source-modified-on=2019-08-24T14:15:22Z \
  -F hp-proof-live-sync-enabled=true

Responses

Success.

Bodyapplication/json
idstring

Unique identifier for the proof item

Example: "4eb909de-51af-11ee-a644-522476618ae8"
orgIdstring

Unique identifier for the organization

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
filenamestring

Name of the uploaded file

Example: "example.txt"
nameOverridestring

Name of proof Hyperproof given by Hyperproof user

contentTypestring

MIME type of the file (e.g.,text/plain)

Example: "text/plain"
fileExtensionstring

File extension (e.g.,txt)

Example: "txt"
sizenumber

File size in bytes

Example: 627
versioninteger

Version of the proof item

sourcestring

Source of the file (e.g.,localComputer)

Example: "localComputer"
sourceVersioninteger

The version of the proof maintained by the source system

ownedBystring

Unique identifier of the user who owns the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
isPrivateboolean

Whether the proof item is private

uploadedOnstring

The date the proof was uploaded (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
statusstring

Status of the proof item

Enum"active""archived""deleted""pending""canceled"
Example: "active"
createdBystring

Unique identifier of the user who created the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring

The date the proof was created (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
updatedBystring

Unique identifier of the user who last updated the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring

The date the proof was updated (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
Response
application/json
{
  "id": "4eb909de-51af-11ee-a644-522476618ae8",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "filename": "example.txt",
  "contentType": "text/plain",
  "fileExtension": "txt",
  "size": 627,
  "version": 0,
  "source": "localComputer",
  "ownedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "uploadedOn": "2023-09-12T20:59:47.6943530+00:00",
  "isPrivate": false,
  "status": "active",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T20:59:47.6943530+00:00",
  "updatedOn": "2023-09-12T20:59:47.6943530+00:00"
}

Get Task Proof Metadata

Request

GET /{taskId}/proof

Description

Retrieves metadata for all proof items linked to a specific task, including details such as file information, sources, and upload timestamps.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}/proof' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring

Unique identifier for the proof item

Example: "4eb909de-51af-11ee-a644-522476618ae8"
orgIdstring

Unique identifier for the organization

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
filenamestring

Name of the uploaded file

Example: "example.txt"
nameOverridestring

Name of proof Hyperproof given by Hyperproof user

contentTypestring

MIME type of the file (e.g.,text/plain)

Example: "text/plain"
fileExtensionstring

File extension (e.g.,txt)

Example: "txt"
sizenumber

File size in bytes

Example: 627
versioninteger

Version of the proof item

sourcestring

Source of the file (e.g.,localComputer)

Example: "localComputer"
sourceVersioninteger

The version of the proof maintained by the source system

ownedBystring

Unique identifier of the user who owns the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
isPrivateboolean

Whether the proof item is private

uploadedOnstring

The date the proof was uploaded (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
statusstring

Status of the proof item

Enum"active""archived""deleted""pending""canceled"
Example: "active"
createdBystring

Unique identifier of the user who created the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring

The date the proof was created (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
updatedBystring

Unique identifier of the user who last updated the proof item

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring

The date the proof was updated (ISO-8601 format)

Example: "2023-09-12T20:59:47.694353Z"
]
Response
application/json
[
  {
    "id": "4eb909de-51af-11ee-a644-522476618ae8",
    "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
    "filename": "example.txt",
    "contentType": "text/plain",
    "fileExtension": "txt",
    "size": 627,
    "version": 0,
    "source": "localComputer",
    "ownedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
    "uploadedOn": "2023-09-12T20:59:47.6943530+00:00",
    "isPrivate": false,
    "status": "active",
    "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
    "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
    "createdOn": "2023-09-12T20:59:47.6943530+00:00",
    "updatedOn": "2023-09-12T20:59:47.6943530+00:00"
  }
]

Get Tasks Filtered

Request

PUT /filter

Description

Retrieves a list of tasks that match the specified filter criteria, such as status, assignee, due date, or category.

Security
oauth2
Bodyapplication/json
targetObjectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
targetObjectIdsArray of strings(uuid)

The list of target object identifiers to filter by.

Example: ["23b802db-bad2-4f7a-b8d1-ac1177909992"]
taskIdsArray of strings(uuid)

The list of task identifiers to filter by.

Example: ["23b802db-bad2-4f7a-b8d1-ac1177909992"]
assigneeIdsArray of strings(uuid)

The list of assignee identifiers to filter tasks by.

Example: ["23b802db-bad2-4f7a-b8d1-ac1177909992"]
modifiedAfterstring(date-time)

Filter tasks that were modified after the date provided (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
curl -i -X PUT \
  https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/filter \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "targetObjectType": "control",
    "targetObjectIds": [
      "23b802db-bad2-4f7a-b8d1-ac1177909992"
    ],
    "taskIds": [
      "23b802db-bad2-4f7a-b8d1-ac1177909992"
    ],
    "assigneeIds": [
      "23b802db-bad2-4f7a-b8d1-ac1177909992"
    ],
    "modifiedAfter": "2020-12-17T20:00:00.0000000+00:00"
  }'

Responses

Success.

Bodyapplication/jsonArray [
idstring(uuid)

The unique identifier of the task.

Example: "ba50096d-bbfa-47af-94a7-092b0984cf35"
orgIdstring

The unique identifier of the organization the task belongs to.

Example: "4c05da3f-f076-461c-8105-80a07a42ab7f"
titlestring

The title of the task.

Example: "Submit the latest employee agreements"
descriptionstring

The description of the task.

Example: "The latest employee agreements are needed for the upcoming audit."
assigneeIdstring

The unique identifier of the user assigned to the task.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
targetIdstring

The unique identifier of the object that is the target of the task.

Example: "23b802db-bad2-4f7a-b8d1-ac1177909992"
targetTypestring

The object type of the target of the task.

Example: "control"
taskStatusIdstring

The unique identifier of the task status for the task.

Example: "e2303b2b-5ee4-4354-92de-dfacd1d33f09"
prioritystring(Priority)

The priority level.

Enum"highest""high""medium""low""lowest"
dueDatestring(date-time)

The due date of the task (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
createdOnstring(date-time)

The date and time the task was created (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
updatedOnstring(date-time)

The date and time the task was last updated (ISO-8601 format).

Example: "2020-12-17T20:00:00Z"
groupIdstring

The unique identifier of the group assigned to the task.

Example: "193ceec7-4911-11ef-8f90-8688bf62af58"
]
Response
application/json
[
  {
    "id": "ba50096d-bbfa-47af-94a7-092b0984cf35",
    "orgId": "4c05da3f-f076-461c-8105-80a07a42ab7f",
    "title": "Submit the latest employee agreements",
    "description": "The latest employee agreements are needed for the upcoming audit.",
    "assigneeId": "ad21d858-c271-4c6d-8780-fecf6b16e534",
    "targetId": "23b802db-bad2-4f7a-b8d1-ac1177909992",
    "targetType": "control",
    "taskStatusId": "e2303b2b-5ee4-4354-92de-dfacd1d33f09",
    "priority": "medium",
    "dueDate": "2020-12-17T20:00:00.0000000+00:00",
    "createdOn": "2020-12-17T20:00:00.0000000+00:00",
    "updatedOn": "2020-12-17T20:00:00.0000000+00:00"
  }
]

Get Task Comments

Request

GET /{taskId}/comments

Description

Retrieves all comments from a specified task's Activity Feed, including their content, authors, and timestamps.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}/comments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring(uuid)

The unique identifier for the comment.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
orgIdstring(uuid)

The unique identifier for the organization the comment belongs to.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
commentTextFormattedstring

The formatted text of the comment.

Example: "This is a comment mentioning a user {{user:53c8880a-7e14-4493-a392-0f10bf11cfce}}"
objectIdstring(uuid)

The unique identifier of the object the comment is attached to.

Example: "ad21d858-c271-4c6d-8780-fecf6b16e534"
objectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
statusstring(ObjectStatus)

The status of the object

Enum"active""archived"
createdBystring(uuid)

The unique identifier of the user who created the comment.

Example: "554fbf38-f579-4cc8-819f-6377bd9defcb"
updatedBystring(uuid)

The unique identifier of the user who last updated the comment.

Example: "53c8880a-7e14-4493-a392-0f10bf11cfce"
createdOnstring(date-time)

The date and time the comment was created (ISO-8601 format).

Example: "2024-06-23T19:37:23+0000"
updatedOnstring(date-time)

The date and time the comment was last updated (ISO-8601 format).

Example: "2024-06-27T22:28:30+0000"
sourceUpdatedOnstring(date-time)

The date and time the comment was updated in teh source system (ISO-8601 format).

deletedOnstring(date-time)

The date and time the comment was deleted (ISO-8601 format).

isInternalboolean

Whether the comment is internal-only and not visible to external auditors.

]
Response
application/json
[
  {
    "id": "ad21d858-c271-4c6d-8780-fecf6b16e534",
    "orgId": "ad21d858-c271-4c6d-8780-fecf6b16e534",
    "commentTextFormatted": "This is a comment mentioning a user {{user:53c8880a-7e14-4493-a392-0f10bf11cfce}}",
    "objectId": "ad21d858-c271-4c6d-8780-fecf6b16e534",
    "objectType": "task",
    "status": "active",
    "createdBy": "554fbf38-f579-4cc8-819f-6377bd9defcb",
    "updatedBy": "53c8880a-7e14-4493-a392-0f10bf11cfce",
    "createdOn": "2024-06-23T19:37:23.0000000+00:00",
    "updatedOn": "2024-06-27T22:28:30.0000000+00:00"
  }
]

Add Task Comment

Request

POST /{taskId}/comments

Description

Adds a new comment to a task’s Activity Feed, recording the message along with its author and timestamp.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task.

Bodyapplication/json
commentTextFormattedstringrequired

The formatted text for the comment.

Example: "The audit is completed."
isInternalCommentboolean

Whether the comment is internal-only. Internal comments are not visible to external auditors.

Example: true
objectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
objectIdstring

The object identifier the comment is attached to.

Example: "82d7c228-8bcd-11e9-a94b-ab3de849498z"
sourceCommentIdstring

The identifier of the comment in the external system from which it was synced.

sourceUpdatedOnstring

The date and time of the source for the comment (ISO-8601 format).

curl -i -X POST \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}/comments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "commentTextFormatted": "The audit is completed.",
    "isInternalComment": true,
    "objectId": "82d7c228-8bcd-11e9-a94b-ab3de849498z",
    "objectType": "risk"
  }'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier of the activity

Example: "a3f89b48-9ae1-4852-a229-c4aea92230b0"
orgIdstring(uuid)

The unique identifier for the organization the activity belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
typestring

The type of the activity.

Enum"event""comment"
Example: "comment"
messagestring

The description of this event.

Example: "This is a comment"
objectIdstring(uuid)

The unique identifier of the object related to the activity.

Example: "16d22ded-88ac-4f5c-bc99-8064d9fc44d7"
objectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
statusstring

The current status of the activity.

Enum"active""deleted""pending""canceled"
Example: "active"
createdBystring(uuid)

The unique identifier of the user who created the activity.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the activity was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring(uuid)

The unique identifier of the user who last updated the activity.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the activity was last updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
Response
application/json
{
  "id": "a3f89b48-9ae1-4852-a229-c4aea92230b0",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "type": "comment",
  "message": "This is a comment",
  "objectId": "16d22ded-88ac-4f5c-bc99-8064d9fc44d7",
  "objectType": "audit",
  "status": "active",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T18:26:10.0053650+00:00",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedOn": "2023-09-12T18:26:10.0053650+00:00"
}

Update Task Comment

Request

PATCH /{taskId}/comments?sourceCommentId={sourceCommentId}

Description

Updates an existing comment in a task's Activity Feed. The comment is matched based on the sourceCommentId query parameter or body.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task.

Query
sourceCommentIdstringrequired

Unique ID of the source comment.

Bodyapplication/json
commentTextFormattedstring

The formatted text of the comment.

Example: "The audit is completed."
isInternalCommentboolean

The flag indicating if the comment is internal-only and not visible to external auditors.

Example: true
curl -i -X PATCH \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}/comments?sourceCommentId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "commentTextFormatted": "The audit is completed.",
    "isInternalComment": true,
    "objectId": "82d7c228-8bcd-11e9-a94b-ab3de849498z",
    "objectType": "risk"
  }'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier of the activity

Example: "a3f89b48-9ae1-4852-a229-c4aea92230b0"
orgIdstring(uuid)

The unique identifier for the organization the activity belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
typestring

The type of the activity.

Enum"event""comment"
Example: "comment"
messagestring

The description of this event.

Example: "This is a comment"
objectIdstring(uuid)

The unique identifier of the object related to the activity.

Example: "16d22ded-88ac-4f5c-bc99-8064d9fc44d7"
objectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
statusstring

The current status of the activity.

Enum"active""deleted""pending""canceled"
Example: "active"
createdBystring(uuid)

The unique identifier of the user who created the activity.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the activity was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring(uuid)

The unique identifier of the user who last updated the activity.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the activity was last updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
Response
application/json
{
  "id": "a3f89b48-9ae1-4852-a229-c4aea92230b0",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "type": "comment",
  "message": "This is a comment",
  "objectId": "16d22ded-88ac-4f5c-bc99-8064d9fc44d7",
  "objectType": "audit",
  "status": "active",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T18:26:10.0053650+00:00",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedOn": "2023-09-12T18:26:10.0053650+00:00"
}

Update Task Comment

Request

PATCH /{taskId}/comments/{commentId}

Description

Updates an existing comment in a task's Activity Feed, modifying its content or associated metadata.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task.

commentIdstringrequired

Unique ID of the comment

Bodyapplication/json
commentTextFormattedstring

The formatted text of the comment.

Example: "The audit is completed."
isInternalCommentboolean

The flag indicating if the comment is internal-only and not visible to external auditors.

Example: true
curl -i -X PATCH \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}/comments/{commentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "commentTextFormatted": "The audit is completed.",
    "isInternalComment": true,
    "objectId": "82d7c228-8bcd-11e9-a94b-ab3de849498z",
    "objectType": "risk"
  }'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier of the activity

Example: "a3f89b48-9ae1-4852-a229-c4aea92230b0"
orgIdstring(uuid)

The unique identifier for the organization the activity belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
typestring

The type of the activity.

Enum"event""comment"
Example: "comment"
messagestring

The description of this event.

Example: "This is a comment"
objectIdstring(uuid)

The unique identifier of the object related to the activity.

Example: "16d22ded-88ac-4f5c-bc99-8064d9fc44d7"
objectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
statusstring

The current status of the activity.

Enum"active""deleted""pending""canceled"
Example: "active"
createdBystring(uuid)

The unique identifier of the user who created the activity.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the activity was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring(uuid)

The unique identifier of the user who last updated the activity.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the activity was last updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
Response
application/json
{
  "id": "a3f89b48-9ae1-4852-a229-c4aea92230b0",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "type": "comment",
  "message": "This is a comment",
  "objectId": "16d22ded-88ac-4f5c-bc99-8064d9fc44d7",
  "objectType": "audit",
  "status": "active",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T18:26:10.0053650+00:00",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedOn": "2023-09-12T18:26:10.0053650+00:00"
}

Delete Task Comment

Request

DEL /{taskId}/comments/{commentId}

Description

Deletes a specified comment from a task, permanently removing it from the task’s Activity Feed and history.

Security
oauth2
Path
taskIdstringrequired

Unique ID of the task.

commentIdstringrequired

Unique ID of the comment

curl -i -X DELETE \
  'https://developer.hyperproof.app/_mock/hyperproof-api/tasks/tasks.openapi/{taskId}/comments/{commentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier of the activity

Example: "a3f89b48-9ae1-4852-a229-c4aea92230b0"
orgIdstring(uuid)

The unique identifier for the organization the activity belongs to.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
typestring

The type of the activity.

Enum"event""comment"
Example: "comment"
messagestring

The description of this event.

Example: "This is a comment"
objectIdstring(uuid)

The unique identifier of the object related to the activity.

Example: "16d22ded-88ac-4f5c-bc99-8064d9fc44d7"
objectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
statusstring

The current status of the activity.

Enum"active""deleted""pending""canceled"
Example: "active"
createdBystring(uuid)

The unique identifier of the user who created the activity.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring(date-time)

The date and time the activity was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring(uuid)

The unique identifier of the user who last updated the activity.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date and time the activity was last updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
Response
application/json
{
  "id": "a3f89b48-9ae1-4852-a229-c4aea92230b0",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "type": "comment",
  "message": "This is a comment",
  "objectId": "16d22ded-88ac-4f5c-bc99-8064d9fc44d7",
  "objectType": "audit",
  "status": "active",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T18:26:10.0053650+00:00",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedOn": "2023-09-12T18:26:10.0053650+00:00"
}
® 2026 Hyperproof All Rights Reserved.