Box Task Assignments API

openapi: 3.2.0
info:
  title: Box Platform Task assignments API
  description: Box Platform provides functionality to provide access to content stored within Box. It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
  termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
  contact:
    name: Box, Inc
    url: https://developer.box.com
    email: devrel@box.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '2024.0'
  x-box-commit-hash: 53bdced3cd
servers:
- url: https://api.box.com/2.0
  description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: Task assignments
  description: A task assignment defines which task is assigned to which user to complete.
  x-box-tag: task_assignments
paths:
  /tasks/{task_id}/assignments:
    get:
      operationId: get_tasks_id_assignments
      summary: List task assignments
      description: Lists all of the assignments for a given task.
      parameters:
      - name: task_id
        in: path
        description: The ID of the task.
        required: true
        schema:
          type: string
        example: '12345'
      responses:
        '200':
          description: Returns a collection of task assignment defining what task on a file has been assigned to which users and by who.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskAssignments'
        '404':
          description: Returns an error when the task could not be found or the user does not have access to the file the task is assigned to.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '500':
          description: Returns an error if the task assignment ID was omitted in the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: task_assignments
      tags:
      - Task assignments
      x-codeSamples:
      - lang: curl
        label: List task assignments
        source: "curl -i -X GET \"https://api.box.com/2.0/tasks/12345/assignments\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: List task assignments
        source: 'await client.TaskAssignments.GetTaskAssignmentsAsync(taskId: NullableUtils.Unwrap(task.Id));'
      - lang: swift
        label: List task assignments
        source: 'try await client.taskAssignments.getTaskAssignments(taskId: task.id!)'
      - lang: java
        label: List task assignments
        source: client.getTaskAssignments().getTaskAssignments(task.getId())
      - lang: node
        label: List task assignments
        source: await client.taskAssignments.getTaskAssignments(task.id!);
      - lang: python
        label: List task assignments
        source: client.task_assignments.get_task_assignments(task.id)
  /task_assignments:
    post:
      operationId: post_task_assignments
      summary: Assign task
      description: 'Assigns a task to a user.


        A task can be assigned to more than one user by creating multiple assignments.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                task:
                  description: The task to assign to a user.
                  type: object
                  properties:
                    id:
                      description: The ID of the task.
                      type: string
                      example: '11446498'
                    type:
                      description: The type of the item to assign.
                      type: string
                      example: task
                      enum:
                      - task
                  required:
                  - id
                  - type
                assign_to:
                  description: The user to assign the task to.
                  type: object
                  properties:
                    id:
                      description: 'The ID of the user to assign to the task.


                        To specify a user by their email address use the `login` parameter.'
                      type: string
                      example: '3242343'
                    login:
                      description: The email address of the user to assign to the task. To specify a user by their user ID please use the `id` parameter.
                      type: string
                      example: john@example.com
              required:
              - task
              - assign_to
      responses:
        '201':
          description: Returns a new task assignment object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskAssignment'
        '403':
          description: Returns an error if a change is attempted for a completed task or the user does not have access to the item linked to the task for the given task assignment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '404':
          description: Returns an error when the task cannot be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '500':
          description: Returns an error if any of the IDs for this request were not valid, or if the targeted user does not have access to the file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: task_assignments
      tags:
      - Task assignments
      x-codeSamples:
      - lang: curl
        label: Assign task
        source: "curl -i -X POST \"https://api.box.com/2.0/task_assignments\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"task\": {\n         \"id\": \"11446498\",\n         \"type\": \"task\"\n       },\n       \"assign_to\": {\n         \"id\": \"4823213\"\n       }\n     }'"
      - lang: dotnet
        label: Assign task
        source: 'await client.TaskAssignments.CreateTaskAssignmentAsync(requestBody: new CreateTaskAssignmentRequestBody(task: new CreateTaskAssignmentRequestBodyTaskField(type: CreateTaskAssignmentRequestBodyTaskTypeField.Task, id: NullableUtils.Unwrap(task.Id)), assignTo: new CreateTaskAssignmentRequestBodyAssignToField() { Id = currentUser.Id }));'
      - lang: swift
        label: Assign task
        source: 'try await client.taskAssignments.createTaskAssignment(requestBody: CreateTaskAssignmentRequestBody(task: CreateTaskAssignmentRequestBodyTaskField(type: CreateTaskAssignmentRequestBodyTaskTypeField.task, id: task.id!), assignTo: CreateTaskAssignmentRequestBodyAssignToField(id: currentUser.id)))'
      - lang: java
        label: Assign task
        source: client.getTaskAssignments().createTaskAssignment(new CreateTaskAssignmentRequestBody(new CreateTaskAssignmentRequestBodyTaskField.Builder(task.getId()).type(CreateTaskAssignmentRequestBodyTaskTypeField.TASK).build(), new CreateTaskAssignmentRequestBodyAssignToField.Builder().id(currentUser.getId()).build()))
      - lang: node
        label: Assign task
        source: "await client.taskAssignments.createTaskAssignment({\n  task: new CreateTaskAssignmentRequestBodyTaskField({\n    type: 'task' as CreateTaskAssignmentRequestBodyTaskTypeField,\n    id: task.id!,\n  }),\n  assignTo: {\n    id: currentUser.id,\n  } satisfies CreateTaskAssignmentRequestBodyAssignToField,\n} satisfies CreateTaskAssignmentRequestBody);"
      - lang: python
        label: Assign task
        source: "client.task_assignments.create_task_assignment(\n    CreateTaskAssignmentTask(type=CreateTaskAssignmentTaskTypeField.TASK, id=task.id),\n    CreateTaskAssignmentAssignTo(id=current_user.id),\n)"
  /task_assignments/{task_assignment_id}:
    get:
      operationId: get_task_assignments_id
      summary: Get task assignment
      description: Retrieves information about a task assignment.
      parameters:
      - name: task_assignment_id
        in: path
        description: The ID of the task assignment.
        required: true
        schema:
          type: string
        example: '12345'
      responses:
        '200':
          description: Returns a task assignment, specifying who the task has been assigned to and by whom.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskAssignment'
        '404':
          description: Returns an error when the task assignment could not be found or the user does not have access to the file the task is assigned to.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: task_assignments
      tags:
      - Task assignments
      x-codeSamples:
      - lang: curl
        label: Get task assignment
        source: "curl -i -X GET \"https://api.box.com/2.0/task_assignments/12345\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Get task assignment
        source: 'await client.TaskAssignments.GetTaskAssignmentByIdAsync(taskAssignmentId: NullableUtils.Unwrap(taskAssignment.Id));'
      - lang: swift
        label: Get task assignment
        source: 'try await client.taskAssignments.getTaskAssignmentById(taskAssignmentId: taskAssignment.id!)'
      - lang: java
        label: Get task assignment
        source: client.getTaskAssignments().getTaskAssignmentById(taskAssignment.getId())
      - lang: node
        label: Get task assignment
        source: await client.taskAssignments.getTaskAssignmentById(taskAssignment.id!);
      - lang: python
        label: Get task assignment
        source: client.task_assignments.get_task_assignment_by_id(task_assignment.id)
    put:
      operationId: put_task_assignments_id
      summary: Update task assignment
      description: Updates a task assignment. This endpoint can be used to update the state of a task assigned to a user.
      parameters:
      - name: task_assignment_id
        in: path
        description: The ID of the task assignment.
        required: true
        schema:
          type: string
        example: '12345'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  description: An optional message by the assignee that can be added to the task.
                  type: string
                  example: Looks good to me
                resolution_state:
                  description: 'The state of the task assigned to the user.


                    - For a task with an `action` value of `complete` this can be `incomplete` or `completed`.

                    - For a task with an `action` of `review` this can be `incomplete`, `approved`, or `rejected`.'
                  type: string
                  example: completed
                  enum:
                  - completed
                  - incomplete
                  - approved
                  - rejected
      responses:
        '200':
          description: Returns the updated task assignment object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskAssignment'
        '400':
          description: Returns an error if a resolution state is incompatible with the action type of the task.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '404':
          description: Returns an error when the task assignment could not be found or the user does not have access to the file the task is assigned to.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: task_assignments
      tags:
      - Task assignments
      x-codeSamples:
      - lang: curl
        label: Update task assignment
        source: "curl -i -X PUT \"https://api.box.com/2.0/task_assignments/12345\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"message\": \"New message\",\n       \"resolution_state\": \"completed\"\n     }'"
      - lang: dotnet
        label: Update task assignment
        source: 'await client.TaskAssignments.UpdateTaskAssignmentByIdAsync(taskAssignmentId: NullableUtils.Unwrap(taskAssignment.Id), requestBody: new UpdateTaskAssignmentByIdRequestBody() { Message = "updated message", ResolutionState = UpdateTaskAssignmentByIdRequestBodyResolutionStateField.Approved });'
      - lang: swift
        label: Update task assignment
        source: 'try await client.taskAssignments.updateTaskAssignmentById(taskAssignmentId: taskAssignment.id!, requestBody: UpdateTaskAssignmentByIdRequestBody(message: "updated message", resolutionState: UpdateTaskAssignmentByIdRequestBodyResolutionStateField.approved))'
      - lang: java
        label: Update task assignment
        source: client.getTaskAssignments().updateTaskAssignmentById(taskAssignment.getId(), new UpdateTaskAssignmentByIdRequestBody.Builder().message("updated message").resolutionState(UpdateTaskAssignmentByIdRequestBodyResolutionStateField.APPROVED).build())
      - lang: node
        label: Update task assignment
        source: "await client.taskAssignments.updateTaskAssignmentById(taskAssignment.id!, {\n  requestBody: {\n    message: 'updated message',\n    resolutionState:\n      'approved' as UpdateTaskAssignmentByIdRequestBodyResolutionStateField,\n  } satisfies UpdateTaskAssignmentByIdRequestBody,\n} satisfies UpdateTaskAssignmentByIdOptionalsInput);"
      - lang: python
        label: Update task assignment
        source: "client.task_assignments.update_task_assignment_by_id(\n    task_assignment.id,\n    message=\"updated message\",\n    resolution_state=UpdateTaskAssignmentByIdResolutionState.APPROVED,\n)"
    delete:
      operationId: delete_task_assignments_id
      summary: Unassign task
      description: Deletes a specific task assignment.
      parameters:
      - name: task_assignment_id
        in: path
        description: The ID of the task assignment.
        required: true
        schema:
          type: string
        example: '12345'
      responses:
        '204':
          description: Returns an empty response when the task assignment was successfully deleted.
        '404':
          description: Returns an error if the task assignment for the given ID does not exist or is inaccessible to your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: task_assignments
      tags:
      - Task assignments
      x-codeSamples:
      - lang: curl
        label: Unassign task
        source: "curl -i -X DELETE \"https://api.box.com/2.0/task_assignments/12345\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Unassign task
        source: 'await client.TaskAssignments.DeleteTaskAssignmentByIdAsync(taskAssignmentId: NullableUtils.Unwrap(taskAssignment.Id));'
      - lang: swift
        label: Unassign task
        source: 'try await client.taskAssignments.deleteTaskAssignmentById(taskAssignmentId: taskAssignment.id!)'
      - lang: java
        label: Unassign task
        source: client.getTaskAssignments().deleteTaskAssignmentById(taskAssignment.getId())
      - lang: node
        label: Unassign task
        source: await client.taskAssignments.deleteTaskAssignmentById(taskAssignment.id!);
      - lang: python
        label: Unassign task
        source: client.task_assignments.delete_task_assignment_by_id(task_assignment.id)
components:
  schemas:
    File--Mini:
      description: A mini representation of a file, used when nested under another resource.
      type:
      - object
      - 'null'
      allOf:
      - $ref: '#/components/schemas/File--Base'
      - properties:
          sequence_id:
            allOf:
            - type:
              - string
              - 'null'
              example: '3'
              description: 'A numeric identifier that represents the most recent user event that has been applied to this item.


                This can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.


                An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.'
            - {}
          name:
            description: The name of the file.
            type: string
            example: Contract.pdf
          sha1:
            description: The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.
            type: string
            format: digest
            example: 85136C79CBF9FE36BB9D05D0639C70C265C18D37
          file_version:
            allOf:
            - $ref: '#/components/schemas/FileVersion--Mini'
            - description: The information about the current version of the file.
      title: File (Mini)
      x-box-resource-id: file--mini
      x-box-tag: files
      x-box-variant: mini
    TaskAssignment:
      description: A task assignment defines which task is assigned to which user to complete.
      type: object
      properties:
        id:
          description: The unique identifier for this task assignment.
          type: string
          example: '11446498'
        type:
          description: The value will always be `task_assignment`.
          type: string
          example: task_assignment
          enum:
          - task_assignment
        item:
          allOf:
          - $ref: '#/components/schemas/File--Mini'
          - description: The file that the task has been assigned to.
        assigned_to:
          allOf:
          - $ref: '#/components/schemas/User--Mini'
          - description: The user that the task has been assigned to.
        message:
          description: A message that will is included with the task assignment. This is visible to the assigned user in the web and mobile UI.
          type: string
          example: Please review
        completed_at:
          description: The date at which this task assignment was completed. This will be `null` if the task is not completed yet.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
        assigned_at:
          description: The date at which this task was assigned to the user.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
        reminded_at:
          description: The date at which the assigned user was reminded of this task assignment.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
        resolution_state:
          description: The current state of the assignment. The available states depend on the `action` value of the task object.
          type: string
          example: incomplete
          enum:
          - completed
          - incomplete
          - approved
          - rejected
        assigned_by:
          allOf:
          - $ref: '#/components/schemas/User--Mini'
          - description: The user who assigned this task.
      title: Task assignment
      x-box-resource-id: task_assignment
      x-box-tag: task_assignments
    TaskAssignments:
      description: A list of task assignments.
      type: object
      properties:
        total_count:
          description: The total number of items in this collection.
          type: integer
          format: int64
          example: 100
        entries:
          description: A list of task assignments.
          type: array
          items:
            $ref: '#/components/schemas/TaskAssignment'
      title: Task assignments
      x-box-resource-id: task_assignments
      x-box-tag: task_assignments
    ClientError:
      description: A generic error.
      type: object
      properties:
        type:
          description: The value will always be `error`.
          type: string
          example: error
          enum:
          - error
        status:
          description: The HTTP status of the response.
          type: integer
          format: int32
          example: 400
        code:
          description: A Box-specific error code.
          type: string
          example: item_name_invalid
          enum:
          - created
          - accepted
          - no_content
          - redirect
          - not_modified
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - method_not_allowed
          - conflict
          - precondition_failed
          - unprocessable_entity
          - too_many_requests
          - internal_server_error
          - unavailable
          - item_name_invalid
          - insufficient_scope
        message:
          description: A short message describing the error.
          type: string
          example: Method Not Allowed
        context_info:
          description: 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.
          type:
          - object
          - 'null'
          example:
            message: Something went wrong
          additionalProperties: {}
        help_url:
          description: A URL that links to more information about why this error occurred.
          type: string
          example: https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
        request_id:
          description: A unique identifier for this response, which can be used when contacting Box support.
          type: string
          example: abcdef123456
      title: Client error
      x-box-resource-id: client_error
    User--Mini:
      description: A mini representation of a user, as can be returned when nested within other resources.
      type: object
      allOf:
      - $ref: '#/components/schemas/User--Base'
      - properties:
          name:
            description: The display name of this user.
            type: string
            example: Aaron Levie
            maxLength: 50
          login:
            description: The primary email address of this user.
            type: string
            format: email
            example: ceo@example.com
      title: User (Mini)
      x-box-resource-id: user--mini
      x-box-tag: users
      x-box-variant: mini
    FileVersion--Base:
      description: The bare basic representation of a file version, the minimal amount of fields returned when using the `fields` query parameter.
      type: object
      properties:
        id:
          description: The unique identifier that represent a file version.
          type: string
          example: '12345'
        type:
          description: The value will always be `file_version`.
          type: string
          example: file_version
          enum:
          - file_version
      required:
      - id
      - type
      title: File version (Base)
      x-box-resource-id: file_version--base
      x-box-variant: base
      x-box-variants:
      - base
      - mini
      - standard
      - full
    FileVersion--Mini:
      description: A mini representation of a file version, used when nested within another resource.
      type: object
      allOf:
      - $ref: '#/components/schemas/FileVersion--Base'
      - properties:
          sha1:
            description: The SHA1 hash of this version of the file.
            type: string
            example: 134b65991ed521fcfe4724b7d814ab8ded5185dc
      title: File version (Mini)
      x-box-resource-id: file_version--mini
      x-box-variant: mini
    File--Base:
      description: The bare basic representation of a file, the minimal amount of fields returned when using the `fields` query parameter.
      type:
      - object
      - 'null'
      properties:
        id:
          description: 'The unique identifier that represent a file.


            The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.'
          type: string
          example: '12345'
        etag:
          description: The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened.
          type:
          - string
          - 'null'
          example: '1'
        type:
          description: The value will always be `file`.
          type: string
          example: file
          enum:
          - file
      required:
      - id
      - type
      title: File (Base)
      x-box-resource-id: file--base
      x-box-tag: files
      x-box-variant: base
      x-box-variants:
      - base
      - mini
      - standard
      - full
    User--Base:
      description: A mini representation of a user, used when nested within another resource.
      type: object
      properties:
        id:
          description: The unique identifier for this user.
          type: string
          example: '11446498'
        type:
          description: The value will always be `user`.
          type: string
          example: user
          enum:
          - user
      required:
      - type
      - id
      title: User (Base)
      x-box-resource-id: user--base
      x-box-tag: users
      x-box-variant: base
      x-box-variants:
      - base
      - mini
      - standard
      - full
  securitySchemes:
    OAuth2Security:
      type: oauth2
      description: The access token received from the authorization server in the OAuth 2.0 flow.
      flows:
        authorizationCode:
          authorizationUrl: https://account.box.com/api/oauth2/authorize
          tokenUrl: https://api.box.com/oauth2/token
          scopes:
            root_readonly: Read all files and folders stored in Box
            root_readwrite: Read and write all files and folders stored in Box
            manage_app_users: Provision and manage app users
            manage_managed_users: Provision and manage managed users
            manage_groups: Manage an enterprise's groups
            manage_webhook: Create webhooks programmatically through the API
            manage_enterprise_properties: Manage enterprise properties
            manage_data_retention: Manage data retention polices
            manage_legal_hold: Manage Legal Holds
externalDocs:
  description: Box Developer Documentation.
  url: https://developer.box.com
x-mint:
  mcp:
    enabled: true
x-provenance:
  method: harvested
  publisher: Box
  source: https://developer.box.com/box-openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)