Create a task

Create a new task for the organization

POST /v1/tasks

Create a task

cURL

curl --request POST \
  --url http://localhost:3333/v1/tasks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "Implement access controls",
  "description": "Set up role-based access controls for the platform",
  "assigneeId": "mem_abc123",
  "frequency": "monthly",
  "department": "it",
  "controlIds": [
    "ctrl_abc123"
  ],
  "taskTemplateId": "tmpl_abc123",
  "vendorId": "vnd_abc123"
}
'

201

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

Authorizations

X-API-Key · string · header · required

API key for authentication

Body

application/json

title · string · required

Example:

"Implement access controls"

description · string · required

Example:

"Set up role-based access controls for the platform"

assigneeId · string | null

Example:

"mem_abc123"

frequency · enum<string> | null

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

Example:

"monthly"

department · enum<string> | null

Available options: none, admin, gov, hr, it, itsm, qms

Example:

"it"

controlIds · string[]

Example:

["ctrl_abc123"]

taskTemplateId · string | null

Example:

"tmpl_abc123"

vendorId · string | null

Vendor ID to connect this task to

Example:

"vnd_abc123"

Response

201

application/json

Task created 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"

description · string

Task description

Example:

"Add OAuth 2.0 authentication to the platform"

taskTemplateId · object

Task template ID

Example:

"frk_tt_68406e353df3bc002994acef"