Get bulk job status | Docusign

{
  "id": "1892e0d1-95c8-4ccd-86b6-705822482bf9",
  "name": "test_name_with_sets_offsite",
  "status": "COMPLETE",
  "status_enum": [
    "OPEN",
    "UPLOAD_COMPLETE",
    "IN_PROGRESS",
    "COMPLETE",
    "FAILED",
    "CANCELED"
  ],
  "created_at": "2025-12-05T20:34:40.529136Z",
  "modified_at": "2025-12-05T20:34:55.677612Z",
  "expires_at": "2025-12-08T20:34:40.529136Z",
  "metadata": {
    "response_timestamp": "2025-12-10T20:43:06.725436506Z",
    "response_duration": 5
  },
  "ttl_period": "P3D",
  "_embedded": {
    "document_status_enum": [
      "NOT_STARTED",
      "IN_PROGRESS",
      "CANCELED",
      "SUCCEEDED",
      "SUCCEEDED_WITH_WARNINGS",
      "FAILED"
    ],
    "documents": [
      {
        "id": "c972fc7c-9abf-4074-bd17-6b0a1a3f103a",
        "status": "FAILED",
        "error_code": 6105,
        "error": "File was not uploaded"
      },
      {
        "id": "60778f49-be9a-48af-a5c8-ce2efc57ab0f",
        "agreement_id": "e4c999b7-bdbd-42a1-99eb-c7569b65d7e7",
        "status": "SUCCEEDED",
        "file_name": "filename.pdf",
        "ai_extraction": true,
        "_links": {
          "document": {
            "href": "https://s1.us.services.demo.docusign.net/document-public-dms/v1/accounts/{accountId}/documents/{documentId}"
          },
          "agreement": {
            "href": "/v1/accounts/{accountId}/agreements/e4c999b7-bdbd-42a1-99eb-c7569b65d7e7"
          }
        }
      },
      {
        "id": "8d9e2654-62ac-40bd-9f34-76424ee8e968",
        "agreement_id": "09ecfcd6-783b-410b-a368-1e4e43fb1c17",
        "status": "SUCCEEDED_WITH_WARNINGS",
        "file_name": "1738567852650_Travelers Auto WC Binder.pdf",
        "ai_extraction": true,
        "warnings": [
          {
            "code": "METADATA_APPLICATION_FAILED",
            "message": "Applying metadata failed",
            "recoverable": true,
            "detail": "Data validation failed. $class may contain an incompatible value.",
            "remedy": "update_metadata"
          }
        ],
        "_actions": {
          "update_metadata": {
            "href": "/v1/accounts/{accountId}/agreements/09ecfcd6-783b-410b-a368-1e4e43fb1c17",
            "method": "PATCH",
            "description": "Submit metadata for this agreement with valid payload"
          }
        },
        "_links": {
          "document": {
            "href": "https://s1.us.services.demo.docusign.net/document-public-dms/v1/accounts/{accountId}/documents/8d9e2654-62ac-40bd-9f34-76424ee8e968"
          },
          "agreement": {
            "href": "/v1/accounts/{accountId}/agreements/09ecfcd6-783b-410b-a368-1e4e43fb1c17"
          }
        }
      }
    ]
  }
}

Get the current status and details of a bulk job.

Authentication

AuthorizationBearer

OAuth2 authentication.

Demo:
- authorizationUrl: https://account-d.docusign.com/oauth/auth
- tokenUrl: https://account-d.docusign.com/oauth/token
Production:
- authorizationUrl: https://account.docusign.com/oauth/auth
- tokenUrl: https://account.docusign.com/oauth/token

Path parameters

accountIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

jobIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

Query parameters

include_document_detailsbooleanOptionalDefaults to true

When false, skips the per-document scan and returns aggregate counts in the summary field instead of _embedded.documents. Significantly improves response time for large jobs when only job status and high-level counts are needed.

Response

The bulk job status and details

idstringformat: "uuid"

Id for job

namestring

User provided name for this job

statusenum

Job lifecycle states:

OPEN - Job created and accepting documents
UPLOAD_COMPLETE - All documents have been received, and processing has not yet started
IN_PROGRESS - Documents are being processed (AI extraction)
COMPLETE - The full e2e process is complete
FAILED - System error prevented job execution
CANCELED - User initiated request to cancel a job

status_enumlist of strings

created_atstringformat: "date-time"

modified_atstringformat: "date-time"

expires_atstringformat: "date-time"

metadataobject

Properties about THIS request/response, not the job resource itself

external_job_idstringOptionalformat: "uuid"

User provided reference ID for this job

ttl_periodstringOptional

ISO 8601 duration for job validity

upload_settingsobjectOptional

Upload configuration settings for the bulk job

ai_processingobjectOptional

AI processing status for BULK_API_INGESTION jobs. Always present; resume_ai_triggered_at is set only for jobs where resume-AI processing was triggered.

summaryobjectOptional

Aggregate document counts. Always present in the job status response alongside _embedded.documents (when include_document_details=true) or as the sole count source (when false).

_embeddedobjectOptional

Contains detailed information about the BulkJob including presigned upload links, document IDs, etc

_action_templatesobjectOptional

_linksobjectOptional

constraintsobjectOptional

Describes the limits of a bulk job, or an action associated with a bulk job

messagestringOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error