Sample - Box Platform API
GET/task_assignments/{task_assignment_id}

Get a task assignment

Retrieves a specific task assignment. Use task_assignment_id to inspect who the task was assigned to, who assigned it, and its current resolution state. The response also includes assignment messages and lifecycle timestamps.

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

1 parameter
task_assignment_idstringrequired
The unique identifier of the task assignment to retrieve.

3 status codes
200Returns the task assignment, including its identifier, assigned user, assigning user, message, assignment timestamps, completion timestamp, and resolution state.
idstringoptional
The unique identifier for this task assignment.
typestringoptional
The value will always be `task_assignment`.
Allowed:task_assignment
itemobjectoptional
assigned_toobjectoptional
messagestringoptional
A message that will is included with the task assignment. This is visible to the assigned user in the web and mobile UI.
completed_atstringoptional
The date at which this task assignment was completed. This will be `null` if the task is not completed yet.
assigned_atstringoptional
The date at which this task was assigned to the user.
reminded_atstringoptional
The date at which the assigned user was reminded of this task assignment.
resolution_statestringoptional
The current state of the assignment. The available states depend on the `action` value of the task object.
Allowed:completedincompleteapprovedrejected
assigned_byobjectoptional
404Returned when the task assignment cannot be found or the user does not have access to the file it is associated with.
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_assignment_id does not identify an accessible task assignment or the user does not have access to its file. Ensure the identifier refers to the assignment you want to retrieve.