Sample - Box Platform API
GET/tasks/{task_id}/assignments

List task assignments

Lists all assignments associated with a specific task. Use task_id to retrieve the users assigned to the task and the users who assigned it. The response includes collection metadata and assignment entries.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
task_idstringrequired
The unique identifier of the task whose assignments to list.

4 status codes
200Returns a task assignment collection containing `total_count` and an `entries` array with assignment details, including the task, assigned user, assigning user, message, timestamps, and resolution state.
total_countintegeroptional
The total number of items in this collection.
entriesarray<TaskAssignment>optional
A list of task assignments.
404Returned when the task cannot be found or the user does not have access to the file the task is assigned to.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
500Returned when the task assignment ID is omitted from the request.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultReturned when an unexpected client error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 404 is returned when task_id does not identify an accessible task or the user does not have access to its file. A 500 is returned if the task assignment ID is omitted from the request.