Task API Documentation

Base URL: https://{tenant-domain}/api/v2/tasks

Parameters:

- notable_type (path parameter): The type of entity (e.g., `client` `application=>application_stage`)

- notable_id (path parameter): The ID of the entity

List Task

Endpoint:/
Method: GET
Description: Retrieves all tasks

Response:

{

"data": [],

“link”:{},

“meta”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

List Individual

Endpoint:/{task_id}
Method: GET
Description: Retrieves individual tasks

Response:

{

"data": [],

“meta”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Uploads Task

Endpoint:/
Method: POST
Description: Uploads documents for a specific entity type and ID

Payload:

{

"assignee_id": “”,

“subject”:””.

“category”:””,

“application_stage_id”:””

}

Response:

{

"uploadedFiles": [],

"rejectedFiles": [

{

"original_name": “",

"path":””,

"type": "pdf",

"description": "",

"file_size": ,

"namespace": "”,

"givenName": ""

}

]

}

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Archive Task

Endpoint:/{task_id}/archive
Method: PUT
Description: archive documents for a specific entity type and ID

Payload:

[]

Response:

{

"data": {},

"assignee":{},

“reporter”:{},

“created_at”:{},

“updated_at”:{}.

“reminder”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Update Task

Endpoint:/{task_id}/archive
Method: PUT
Description: Update task

Payload:

{

“{field_to_update}”:””, //here field_to_update is the filed to be updated (options are: status, priority,due_date(yy-mm-dd),due_time(hh:mm AM/PM),assignee_id,description,follower_ids([]),attachments(form type field)

“_method”:”PUT”

Response:

{

"data": {},

"assignee":{},

“reporter”:{},

“created_at”:{},

“updated_at”:{}.

“reminder”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Update Comment

Endpoint:/{task_id}/archive
Method: POST
Description: update comment of specific task

Payload:

{

“message”:””

}

Response:

[]

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Delete Attachment

Endpoint:/{task_id}/archive
Method: DELETE
Description:Delete attachments from task

Payload:

{

“ids”:[],

“_method”:”delete”

}

Response:

[]

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Task Remider

Endpoint:/{task_id}/reminder
Method: POST
Description:Add reminder

Payload:

{

“channel”:””, //email/notification,both

“duration”:”” //numeric value,

"duration_type": "minutes", //minutes/hour/days

“_method": "POST"

}

Response:

[]

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Update Task Remider

Endpoint:/{task_id}/reminder
Method: PUT
Description:Edit reminder

Payload:

{

"id": "",

"task_id": ,

"channel": "",

"duration": ,

"duration_type": “",

"_method": "PUT"

}

Response:

{

“data”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Base URL: https://{tenant-domain}/api/v2/tasks

Parameters:

- notable_type (path parameter): The type of entity (e.g., `client` `application=>application_stage`)

- notable_id (path parameter): The ID of the entity

List Task

Endpoint:/
Method: GET
Description: Retrieves all tasks

Response:

{

"data": [],

“link”:{},

“meta”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

List Individual

Endpoint:/{task_id}
Method: GET
Description: Retrieves individual tasks

Response:

{

"data": [],

“meta”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Uploads Task

Endpoint:/
Method: POST
Description: Uploads documents for a specific entity type and ID

Payload:

{

"assignee_id": “”,

“subject”:””.

“category”:””,

“application_stage_id”:””

}

Response:

{

"uploadedFiles": [],

"rejectedFiles": [

{

"original_name": “",

"path":””,

"type": "pdf",

"description": "",

"file_size": ,

"namespace": "”,

"givenName": ""

}

]

}

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Archive Task

Endpoint:/{task_id}/archive
Method: PUT
Description: archive documents for a specific entity type and ID

Payload:

[]

Response:

{

"data": {},

"assignee":{},

“reporter”:{},

“created_at”:{},

“updated_at”:{}.

“reminder”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Update Task

Endpoint:/{task_id}/archive
Method: PUT
Description: Update task

Payload:

{

“_method”:”PUT”

Response:

{

"data": {},

"assignee":{},

“reporter”:{},

“created_at”:{},

“updated_at”:{}.

“reminder”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Update Comment

Endpoint:/{task_id}/archive
Method: POST
Description: update comment of specific task

Payload:

{

“message”:””

}

Response:

[]

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Delete Attachment

Endpoint:/{task_id}/archive
Method: DELETE
Description:Delete attachments from task

Payload:

{

“ids”:[],

“_method”:”delete”

}

Response:

[]

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Task Remider

Endpoint:/{task_id}/reminder
Method: POST
Description:Add reminder

Payload:

{

“channel”:””, //email/notification,both

“duration”:”” //numeric value,

"duration_type": "minutes", //minutes/hour/days

“_method": "POST"

}

Response:

[]

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Update Task Remider

Endpoint:/{task_id}/reminder
Method: PUT
Description:Edit reminder

Payload:

{

"id": "",

"task_id": ,

"channel": "",

"duration": ,

"duration_type": “",

"_method": "PUT"

}

Response:

{

“data”:{}

}

HTTP Status Codes:

- 200 OK: Success

- 400 Bad Request: Validation error

- 401 Unauthorized: Invalid or missing authentication

- 403 Forbidden: Insufficient permissions

- 404 Not Found: Entity not found

Help center

Task API Documentation

The Task API provides endpoints for managing notes across different entity types (clients, applications, etc.) in the Agentcis system. This API supports CRUD operations for tasks with proper authorization and validation.

List Task

List Individual

Uploads Task

Archive Task

Payload:

Response:

HTTP Status Codes:

Update Task

Payload:

Update Comment

Payload:

Response:

HTTP Status Codes:

Delete Attachment

Payload:

Response:

HTTP Status Codes:

Task Remider

Payload:

Response:

HTTP Status Codes:

Update Task Remider

Payload:

Response:

HTTP Status Codes:

Help center

Task API Documentation

The Task API provides endpoints for managing notes across different entity types (clients, applications, etc.) in the Agentcis system. This API supports CRUD operations for tasks with proper authorization and validation.

List Task

List Individual

Uploads Task

Archive Task

Payload:

Response:

HTTP Status Codes:

Update Task

Payload:

Update Comment

Payload:

Response:

HTTP Status Codes:

Delete Attachment

Payload:

Response:

HTTP Status Codes:

Task Remider

Payload:

Response:

HTTP Status Codes:

Update Task Remider

Payload:

Response:

HTTP Status Codes: