Skip to main content
POST
/
v1
/
task-management
Create a new task item
curl --request POST \
  --url http://localhost:3333/v1/task-management \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "Review vendor contract",
  "entityId": "<string>",
  "entityType": "vendor",
  "description": "<string>",
  "status": "todo",
  "priority": "medium",
  "assigneeId": "<string>"
}
'
{
  "id": "tski_abc123def456",
  "title": "Review vendor contract",
  "description": {},
  "status": "todo",
  "priority": "urgent",
  "entityId": "<string>",
  "entityType": "vendor",
  "assignee": {
    "id": "<string>",
    "user": {}
  },
  "createdBy": {
    "id": "<string>",
    "user": {}
  },
  "updatedBy": {
    "id": "<string>",
    "user": {}
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Headers

​
X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Body

application/json
​
title
string
required

Task title

Example:

"Review vendor contract"

​
entityId
string
required

ID of the entity this task belongs to

​
entityType
enum<string>
required

Type of entity

Available options:
vendor,
risk
Example:

"vendor"

​
description
string

Task description

​
status
enum<string>
default:todo

Task status

Available options:
todo,
in_progress,
in_review,
done,
canceled
​
priority
enum<string>
default:medium

Task priority

Available options:
urgent,
high,
medium,
low
​
assigneeId
string

Assignee member ID

Response

201 - application/json

Task item created successfully

​
id
string
required

Task item ID

Example:

"tski_abc123def456"

​
title
string
required

Task title

Example:

"Review vendor contract"

​
description
object
required

Task description

​
status
enum<string>
required

Task status

Available options:
todo,
in_progress,
in_review,
done,
canceled
​
priority
enum<string>
required

Task priority

Available options:
urgent,
high,
medium,
low
​
entityId
string
required

ID of the entity this task belongs to

​
entityType
enum<string>
required

Type of entity

Available options:
vendor,
risk
​
assignee
object
required

Assignee information

​
createdBy
object
required

Creator information

​
updatedBy
object
required

Last updater information

​
createdAt
string<date-time>
required

Creation timestamp

​
updatedAt
string<date-time>
required

Last update timestamp