Gets details for a specific upload request | Docusign

{
  "upload_request_id": "8d7c6b5a-4f3e-2d1c-b9a8-7e6f5d4c3b2a",
  "workspace_id": "113e81b7-706e-4cab-9257-73b06325266e",
  "name": "Contract Documents Upload",
  "upload_request_owner": {
    "user_id": "211e2d22-f070-4c8d-b6a7-ecb14ceb81b4"
  },
  "status": "in_progress",
  "documents": [
    {
      "document_name": "Contract Agreement.pdf",
      "document_id": "9e2f4a8b-3c7d-4e5f-a1b2-8c9d6e3f4a7b"
    }
  ],
  "assignments": [
    {
      "assignee_user_id": "3b2c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
    }
  ],
  "created_date": "2025-09-01T12:00:00Z",
  "updated_date": "2025-09-01T12:00:00Z",
  "description": "Please upload the signed contract documents for review",
  "due_date": "2025-09-08T12:00:00Z",
  "sent_date": "2025-09-01T12:00:00Z",
  "completed_date": null
}

This operation retrieves details about a specific upload request within a workspace. The response includes comprehensive information about the upload request including status, assigned users, associated documents, owner details, and various dates.

Required authentication scopes: dtr.rooms.read

Authentication

AuthorizationBearer

JWT Bearer token from Docusign authorization server

Path parameters

accountIdstringRequiredformat: "uuid"

The ID of the account

workspaceIdstringRequiredformat: "uuid"

The ID of the workspace

uploadRequestIdstringRequiredformat: "uuid"

The ID of the upload request

Response

Upload request details successfully retrieved

upload_request_idstringformat: "uuid"

The ID of the upload request

workspace_idstringformat: "uuid"

The ID of the workspace

namestring or null

The name of the upload request

upload_request_ownerobject

statusenum

Enum representing the status of a workspace upload request

Allowed values:

documentslist of objects or null

List of documents associated with the upload request

assignmentslist of objects or null

List of user assignments for the upload request

created_datedatetime or null

The date the upload request was created

updated_datedatetime or null

The date the upload request was last updated

descriptionstring or nullOptional

The description of the upload request

due_datedatetime or nullOptional

The due date for the upload request

sent_datedatetime or nullOptional

The date the upload request was sent

completed_datedatetime or nullOptional

The date the upload request was completed

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error