Skip Navigation Links

Task Assignments

Endpoint Overview

GET /api/tasks/v4/tasks/assignments
Get task assignments
DELETE /api/tasks/v4/tasks/assignments/{assignment_id}
Delete existing task assignment
POST /api/tasks/v4/tasks/assignments/{assignment_id}/finish
Mark task assignment as finished
POST /api/tasks/v4/tasks/assignments/{assignment_id}/open
Mark task assignment as open
GET /api/tasks/v4/tasks/{task_id}/assignments
Get task assignments for task
POST /api/tasks/v4/tasks/{task_id}/assignments
Create new task assignment
POST /api/tasks/v4/tasks/{task_id}/assignments/batch
Create multiple task assignments
DELETE /api/tasks/v4/tasks/{task_id}/assignments/batch
Delete multiple task assignments

Get task assignmentsexperimental

Requires authentication via bearer.

Retrieve my assignments matching one of the given distribution types RECEIVED or PERSONAL and optional embedding of the task

Query Params

distribution_kind string[]

filters task assignments based on their association with the actor. Multiple values can be used.

  • RECEIVED: Tasks received by the actor, excluding personal tasks.
  • PERSONAL: Personal tasks of the actor.
progress_status string[]

Filter for the assignment progress status. Possible values are:

  • NEW: The recipient has never seen the task before.
  • OPEN: The recipient has seen but not finished the task.
  • FINISHED: The recipient has finished the task.
sort string[]
body_format string[]

restricts the returned formatted content to the specified formats

  • PLAIN: the plain content is returned.
  • DELTA: the content is returned in delta format
  • HTML: the content is returned in html format
page_cursor string

A cursor pointing to the first item to be contained in the response array. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

Response Body

200 OK

Error Codes

  • DISTRIBUTION_KIND_UNDEFINED
  • FEATURE_DISABLED

Delete existing task assignmentexperimental

Requires authentication via bearer.

Removes an assignment from a task. The assignment is no longer available. The operation cannot be undone.

Path Params

assignment_id stringrequired

The primary identifier of the assignment to access.

Response Body

204 No Content

Error Codes

  • TASK_NOT_FOUND
  • FEATURE_DISABLED
  • TASK_ASSIGNMENT_NOT_FOUND
  • TASK_ASSIGNMENTS_LOWER_LIMIT_VIOLATION

Mark task assignment as finishedexperimental

Requires authentication via bearer.

Marks a task assignment as finished.

Path Params

assignment_id stringrequired

The primary identifier of the assignment to mark as finished.

Response Body

200 OK

Error Codes

  • FEATURE_DISABLED
  • TASK_ASSIGNMENT_CHANGE_CONFLICT
  • TASK_ASSIGNMENT_NOT_FOUND
  • TASK_NOT_FOUND

Mark task assignment as openexperimental

Requires authentication via bearer.

Marks a task assignment as opened.

Path Params

assignment_id stringrequired

The primary identifier of the assignment to mark as open.

Response Body

200 OK

Error Codes

  • FEATURE_DISABLED
  • TASK_ASSIGNMENT_CHANGE_CONFLICT
  • TASK_ASSIGNMENT_NOT_FOUND
  • TASK_NOT_FOUND

Get task assignments for taskexperimental

Requires authentication via bearer.

Retrieves a paginated list of assignments of a specific task sorted ascending by the last name of the recipient

Path Params

task_id stringrequired

The primary identifier of the task to access.

Query Params

embed string[]
page_cursor string

A cursor pointing to the first item to be contained in the response array. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

sort string[]
progress_status string[]

Filter for the assignment progress status. Possible values are:

  • NEW: The recipient has never seen the task before.
  • OPEN: The recipient has seen but not finished the task.
  • FINISHED: The recipient has finished the task.
body_format string[]

restricts the returned formatted content to the specified formats

  • PLAIN: the plain content is returned.
  • DELTA: the content is returned in delta format
  • HTML: the content is returned in html format

Response Body

200 OK

Error Codes

  • FEATURE_DISABLED
  • TASK_NOT_FOUND
  • VALIDATION_ERROR

Create new task assignmentexperimental

Requires authentication via bearer.

Assigns a task to a new user or channel.

Path Params

task_id stringrequired

The primary identifier of the task to access.

Request Body

recipient objectrequired

Response Body

200 OK
201 Created

Error Codes

  • FEATURE_DISABLED
  • NOT_ADMIN_OF_CHANNEL
  • TASK_NOT_FOUND
  • UNKNOWN_CHANNEL_ID
  • UNKNOWN_USER_ID
  • VALIDATION_ERROR

Create multiple task assignmentsexperimental

Requires authentication via bearer.

Creates multiple assignments on a task at once.

Path Params

task_id stringrequired

The primary identifier of the task to access.

Request Body

user_ids object[]

Response Body

200 OK
201 Created

Error Codes

  • FEATURE_DISABLED
  • NOT_ADMIN_OF_CHANNEL
  • TASK_NOT_FOUND
  • UNKNOWN_USER_ID
  • UNKNOWN_CHANNEL_ID

Delete multiple task assignmentsexperimental

Requires authentication via bearer.

Removes multiple assignments from a task at once. This operation cannot be undone.

Path Params

task_id stringrequired

The primary identifier of the task to access.

Request Body

assignment_ids object[]

Response Body

200 OK

Error Codes

  • TASK_NOT_FOUND
  • FEATURE_DISABLED
  • TASK_ASSIGNMENT_NOT_FOUND
  • TASK_ASSIGNMENTS_LOWER_LIMIT_VIOLATION
  • UNKNOWN_TASK_ASSIGNMENT_ID
  • VALIDATION_ERROR