---
title: "Get Batch Upload Status"
method: GET
path: "/apiHub/learningManagementSystem/v1/companies/{companyId}/batchedContent/{bulkUploadId}/status"
tags: ["Training Content"]
---

# Get Batch Upload Status

`GET /apiHub/learningManagementSystem/v1/companies/{companyId}/batchedContent/{bulkUploadId}/status`

## Request

- Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known)
- URL: `dc1demogwext.paylocity.com/apiHub/learningManagementSystem/v1/companies/{companyId}/batchedContent/{bulkUploadId}/status`
- Auth: none declared

> 🚧 Partner Restricted
> All LMS API endpoints are restricted to LMS providers that have signed a Paylocity technology partnership agreement.
> [Please reach out to our team](https://www.paylocity.com/contact/partner-form/) if you would like to discuss partnership opportunities.

**Summary Description**

Returns the status of a bulk upload operation, including overall progress, success/failure counts, and detailed status for each content item. Partners can call this endpoint at any time to monitor the progress of their bulk upload.

Use `includeDetails=false` (default) for lightweight polling and `includeDetails=true` when detailed per-item diagnostics are needed.

**Use Cases**

- Partner wants to check the progress of a bulk upload operation.
- Partner needs to identify which content items succeeded or failed.
- Partner wants detailed error messages for failed items.

**Status Values**

- `Pending`: Bulk upload request created, waiting for ZIP file upload
- `Downloading`: ZIP file is being downloaded from File Access
- `Downloaded`: ZIP file downloaded and extracted
- `Processing`: Content items are being created in LMS
- `Uploading`: Content files are being uploaded to LMS
- `Created`: All content items created successfully (before upload)
- `PartialCreated`: Some content items created, some failed (before upload)
- `CreationFailed`: All content items failed to create
- `Completed`: All content items successfully processed and uploaded
- `PartialSuccess`: Some content items succeeded, some failed
- `Failed`: All content items failed to process

## Path parameters

- `companyId` string, required
- `bulkUploadId` string, required

## Query parameters

- `includeDetails` boolean

## Headers

- `testMode` boolean

## Response `200`

OK - Returns the bulk upload status.

- BulkUploadStatusResponseDto: Response DTO for bulk upload status query.
  - `bulkUploadId` string, nullable: Unique identifier for the bulk upload operation.
  - `companyId` string, nullable: The Paylocity Company Identifier.
  - `status` 'Pending' | 'Downloading' | 'Downloaded' | 'Processing' | 'Uploading' | 'Created' | 'PartialCreated' | 'CreationFailed' | 'Completed' | 'PartialSuccess' | 'Failed': Overall status of the bulk upload operation.
  - `totalItems` integer: Total number of content items in the bulk upload.
  - `successfulItems` integer: Number of content items successfully processed and created in LMS.
  - `failedItems` integer: Number of content items that failed during processing.
  - `pendingItems` integer: Number of content items still pending processing.
  - `startedAt` string, date-time, nullable: ISO 8601 timestamp when the bulk upload processing started.
  - `completedAt` string, date-time, nullable: ISO 8601 timestamp when the bulk upload processing completed (null if still processing).
  - `items` BulkUploadItemStatusDto[], nullable: Detailed status for each content item (only included if includeDetails=true in query parameter).
    - `itemIndex` integer: Zero-based index of the content item in the original request.
    - `title` string, nullable: Title of the content item.
    - `status` 'Pending' | 'Success' | 'Failed' | 'NotFound' | 'Uploaded' | 'UploadFailed': Status of this specific content item.
    - `contentId` string, nullable: Content ID assigned by LMS Domain API (null if not yet created).
    - `processedAt` string, date-time, nullable: ISO 8601 timestamp when this item was processed (null if pending).
    - `error` string, nullable: Error message if processing failed (null if successful or pending).
  - `errors` BulkUploadErrorDto[], nullable: Summary of errors encountered during processing.
    - `itemIndex` integer: Zero-based index of the content item that failed.
    - `title` string, nullable: Title of the content item that failed.
    - `error` string, nullable: Error message describing the failure.
    - `timestamp` string, date-time: ISO 8601 timestamp when the error occurred.

## Other responses

- `400`: Bad Request - Returns the details of the error.
- `404`: Not Found - Bulk upload not found.

---

[API](https://skmtc.dev/paylocity/apis/learning-management-api.md) - [All operations](https://skmtc.dev/paylocity/apis/learning-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/learning-management-api/revisions/d7411725ee2c?raw)