# Blue Prism Work Queues API

**Canonical:** https://apis.io/apis/blue-prism/blue-prism-work-queues-api/  
**Provider:** Blue Prism — https://apis.io/providers/blue-prism/  
**Base URL:** https://{address}/api/v7  
**Documentation:** https://documentation.blueprism.com/bp-7-5/en-us/bp-api/api-spec-home.htm

Blue Prism Work Queues API is one of 18 APIs that [Blue Prism](https://apis.io/providers/blue-prism/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Work Queues. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

The Work Queues API from Blue Prism — 12 operation(s) for work queues.

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v7/workqueues` | Return a list of work queues in the environment |
| POST | `/api/v7/workqueues` | Create a new work queue |
| GET | `/api/v7/workqueues/light` | Return fewer information about work queue(all fields except work queue… |
| GET | `/api/v7/workqueues/configurations` | Return configuration(id, name, assignedProcessId, assignedResourceGroupId and… |
| GET | `/api/v7/workqueues/{workQueueId}` | Return details of a work queue |
| PATCH | `/api/v7/workqueues/{workQueueId}` | Modify the work queue as described in the patch document |
| DELETE | `/api/v7/workqueues/{workQueueId}` | Delete a specified work queue |
| GET | `/api/v7/workqueues/{workQueueId}/references` | Return references to a specified work queue |
| GET | `/api/v7/workqueues/{workQueueId}/items` | Return items in a specified work queue |
| POST | `/api/v7/workqueues/{workQueueId}/items` | Create work queue item(s) |
| POST | `/api/v7/workqueues/{workQueueId}/items/batch` | Create work queue items |
| GET | `/api/v7/workqueues/items/{workQueueItemId}` | Return details of a specified item from a work queue |
| GET | `/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}` | Return details of a specified item from a work queue |
| GET | `/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts` | Returns all attempts for the given work queue item |
| POST | `/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts` | Creates a new work queue item attempt by forcing an item to retry |
| DELETE | `/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts/{attemptId}` | Deletes a worked queue item |
| PATCH | `/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/attempts/{attemptId}` | Modify the work queue item as described in the patch document |
| POST | `/api/v7/workqueues/{workQueueId}/items/{workQueueItemId}/callbacks` | Creates a new work queue web hook item |

## Machine-readable artifacts (13)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/openapi/blue-prism-work-queues-api-openapi.yml
- **Documentation** — https://documentation.blueprism.com/bp-7-5/en-us/bp-api/api-spec-home.htm
- **APIReference** — https://documentation.blueprism.com/bp-7-5/en-us/bp-api/bpe-7-5-1-api-spec.html
- **GettingStarted** — https://documentation.blueprism.com/bp-7-5/en-us/Guides/bp-api/api-introduction.htm
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/authentication/blue-prism-authentication.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/scopes/blue-prism-scopes.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/conventions/blue-prism-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/errors/blue-prism-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/data-model/blue-prism-data-model.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/asyncapi/blue-prism-webhooks.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/lifecycle/blue-prism-lifecycle.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/conformance/blue-prism-conformance.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/blue-prism/refs/heads/main/rate-limits/blue-prism-rate-limits.yml

## Other Blue Prism APIs (12)

- [Process Intelligence API](https://apis.io/apis/blue-prism/process-intelligence/)
- [Blue Prism Calendars API](https://apis.io/apis/blue-prism/blue-prism-calendars-api/)
- [Blue Prism Dashboards API](https://apis.io/apis/blue-prism/blue-prism-dashboards-api/)
- [Blue Prism Encryption Schemes API](https://apis.io/apis/blue-prism/blue-prism-encryption-schemes-api/)
- [Blue Prism Environment Variables API](https://apis.io/apis/blue-prism/blue-prism-environment-variables-api/)
- [Blue Prism Health API](https://apis.io/apis/blue-prism/blue-prism-health-api/)
- [Blue Prism Licenses API](https://apis.io/apis/blue-prism/blue-prism-licenses-api/)
- [Blue Prism Pools API](https://apis.io/apis/blue-prism/blue-prism-pools-api/)
- [Blue Prism Processes API](https://apis.io/apis/blue-prism/blue-prism-processes-api/)
- [Blue Prism Resources API](https://apis.io/apis/blue-prism/blue-prism-resources-api/)
- [Blue Prism Schedule Logs API](https://apis.io/apis/blue-prism/blue-prism-schedulelogs-api/)
- [Blue Prism Schedules API](https://apis.io/apis/blue-prism/blue-prism-schedules-api/)

## Tags

Work Queues

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/blue-prism/blue-prism-work-queues-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/blue-prism/.