Get task by ID | Comp AI API

Get task by ID in Comp AI. Manage compliance task lifecycle, assignments, review approvals, evidence uploads, policy links, and activity history.

GET /v1/tasks/{taskId}

Get task by ID

cURL

curl --request GET \
  --url https://api.trycomp.ai/v1/tasks/{taskId} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.trycomp.ai/v1/tasks/{taskId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/tasks/{taskId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "id": "tsk_abc123def456",
  "title": "Implement user authentication",
  "description": "Add OAuth 2.0 authentication to the platform",
  "status": "in_progress",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

{
  "message": "Task with ID tsk_abc123def456 not found"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

taskId · string · required

Unique task identifier

Example:

"tsk_abc123def456"

Response

200

application/json

Task retrieved successfully

id · string · required

Unique identifier for the task

Example:

"tsk_abc123def456"

title · string · required

Task title

Example:

"Implement user authentication"

status · enum<string> · required

Task status

Available options: todo, in_progress, done, blocked

Example:

"in_progress"

createdAt · string<date-time> · required

Task creation timestamp

Example:

"2024-01-15T10:30:00Z"

updatedAt · string<date-time> · required

Task last update timestamp

Example:

"2024-01-15T10:30:00Z"

integrationScheduleFrequency · enum<string> · required

Cadence for running the integration check attached to this task

Available options: daily, weekly, monthly, quarterly, yearly

Example:

"daily"

description · string

Task description

Example:

"Add OAuth 2.0 authentication to the platform"

taskTemplateId · object | null

Task template ID

Example:

"frk_tt_68406e353df3bc002994acef"

integrationLastRunAt · object | null

Last successful integration check run timestamp