Skip to main content
GET
/
v1
/
task-management
Get task items for an entity
curl --request GET \
  --url https://api.trycomp.ai/v1/task-management \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "tski_abc123def456",
      "title": "Review vendor contract",
      "description": {},
      "entityId": "<string>",
      "assignee": {
        "id": "<string>",
        "user": {}
      },
      "createdBy": {
        "id": "<string>",
        "user": {}
      },
      "updatedBy": {
        "id": "<string>",
        "user": {}
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Query Parameters

​
entityId
string
required

ID of the entity to get task items for

Example:

"vnd_abc123def456"

​
entityType
enum<string>
required

Type of entity

Available options:
vendor,
risk
Example:

"vendor"

​
page
number
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

​
limit
number
default:5

Number of items per page

Required range: 1 <= x <= 100
Example:

5

​
status
enum<string>

Filter by status

Available options:
todo,
in_progress,
in_review,
done,
canceled
Example:

"todo"

​
priority
enum<string>

Filter by priority

Available options:
urgent,
high,
medium,
low
Example:

"high"

​
assigneeId
string

Filter by assignee ID

Example:

"mbr_abc123def456"

​
sortBy
enum<string>
default:createdAt

Sort by field

Available options:
createdAt,
updatedAt,
title,
status,
priority
Example:

"createdAt"

​
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

Response

200 - application/json

Task items retrieved successfully

​
data
object[]
required

Array of task items

​
meta
object
required

Pagination metadata