automation-anywhere Queues API

Create and manage work item queues and their members

Documentation GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /queues/{id} Get a work item queue's details · Get a queue by ID #

Ask an LLM

“What is the configuration and status of a specific work item queue?”

“Which work item model and processing order does a queue use?”

Tell an agent

Show the details of queue {id}.

Get the work item model and status for queue {id}.

POST /queues/{id}/consumers Add a role as a queue consumer · Add a queue consumer #

Ask an LLM

“How do I let bots under a role process work items from a queue?”

“Who is allowed to add consumer roles to a queue?”

Tell an agent

Add role {roleId} as a consumer of queue {id}.

Let bots in role {roleId} work items from queue {id}.

PUT /queues/{id}/members/{userId} Add or change a queue member · Add or update a queue member #

Ask an LLM

“Can I make a user an owner or member of a work item queue?”

“Is it possible to change a person's membership role on an existing queue?”

Tell an agent

Make user {userId} a {role} of queue {id}.

Add user {userId} as a member of queue {id}.

POST /queues/{id}/participants Add a participant to a queue · Add a queue participant #

Ask an LLM

“Can I give someone view-only style access to a queue's status and work items?”

“What can a queue participant do compared to an owner?”

Tell an agent

Add user {userId} as a participant of queue {id}.

Let user {userId} watch queue {id} as a participant.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/automation-anywhere:automation-anywhere-queues-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Automation Anywhere Workload Management Queues API
  description: The Automation Anywhere Workload Management API provides programmatic control over work item queues used to distribute high-volume automation workloads across multiple Bot Runner devices.
  version: v4
  contact:
    name: Automation Anywhere Support
    url: https://support.automationanywhere.com
  termsOfService: https://www.automationanywhere.com/terms-of-service
servers:
- url: https://{controlRoomUrl}/v4/wlm
  description: Automation Anywhere Control Room Workload Management v4
  variables:
    controlRoomUrl:
      default: your-control-room.automationanywhere.com
      description: Your Control Room hostname
security:
- bearerAuth: []
- xAuthorization: []
tags:
- name: Queues
  description: Create and manage work item queues and their members
paths:
  /queues/{id}:
    get:
      operationId: getQueue
      summary: Get a queue by ID
      description: Retrieves detailed information about a specific work item queue, including its configuration, associated work item model, processing order, and current status.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/QueueIdParam'
      responses:
        '200':
          description: Queue details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Queue not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /queues/{id}/consumers:
    post:
      operationId: addQueueConsumer
      summary: Add a queue consumer
      description: Adds a role as a consumer of the specified queue. Consumer roles are assigned to bots that will process work items from the queue. Only users with queue management permissions can add consumers.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/QueueIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueueConsumerRequest'
      responses:
        '200':
          description: Consumer added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueConsumer'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Queue not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /queues/{id}/members/{userId}:
    put:
      operationId: addOrUpdateQueueMember
      summary: Add or update a queue member
      description: Adds a user as a member of the specified queue or updates the existing membership configuration. Queue members are human users who can manage queue operations such as reviewing failed items.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/QueueIdParam'
      - $ref: '#/components/parameters/UserIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueueMemberRequest'
      responses:
        '200':
          description: Queue member added or updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueMember'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Queue or user not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /queues/{id}/participants:
    post:
      operationId: addQueueParticipant
      summary: Add a queue participant
      description: Adds a participant to the specified queue. Participants can view queue status and work item data but have limited management permissions compared to queue owners or members.
      tags:
      - Queues
      parameters:
      - $ref: '#/components/parameters/QueueIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueueParticipantRequest'
      responses:
        '200':
          description: Participant added successfully
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Queue not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    QueueConsumerRequest:
      type: object
      description: Request to add a role as a consumer of a queue
      properties:
        roleId:
          type: integer
          format: int64
          description: ID of the role to grant consumer access to the queue
    QueueExpiry:
      type: object
      description: Expiry configuration for work items in the queue
      properties:
        type:
          type: string
          description: Expiry type (e.g., DURATION, DATE)
        duration:
          type: integer
          description: Duration value before work items expire
        durationUnit:
          type: string
          description: Time unit for the duration (e.g., HOURS, DAYS)
    QueueMemberRequest:
      type: object
      description: Request to add or update a user as a queue member
      properties:
        role:
          type: string
          description: Queue membership role (OWNER, MEMBER, PARTICIPANT)
          enum:
          - OWNER
          - MEMBER
          - PARTICIPANT
    QueueConsumer:
      type: object
      description: A role with consumer access to a queue
      properties:
        roleId:
          type: integer
          format: int64
          description: ID of the consumer role
        roleName:
          type: string
          description: Name of the consumer role
    Queue:
      type: object
      description: A work item queue that buffers data items for processing by bots. Each queue is linked to a work item model defining its schema.
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the queue
        name:
          type: string
          description: Human-readable name of the queue
        description:
          type: string
          description: Description of the queue's purpose
        reactivationThreshold:
          type: integer
          description: Percentage threshold of remaining work items below which the queue triggers reactivation of additional bot instances
        manualProcessingTime:
          type: integer
          description: Estimated manual processing time per work item for SLA calculations
        manualProcessingTimeUnit:
          type: string
          description: Time unit for manualProcessingTime (e.g., minutes, hours)
        disallowDuplicate:
          type: boolean
          description: Whether duplicate work items based on hash are rejected
        autoRetryLimit:
          type: integer
          description: Maximum number of times a failed work item is automatically retried
        status:
          type: string
          description: Current operational status of the queue
          enum:
          - ACTIVE
          - INACTIVE
        workItemModelId:
          type: integer
          format: int64
          description: ID of the work item model defining this queue's data schema
        workItemProcessingOrders:
          type: array
          description: Ordered list of field names defining work item processing priority
          items:
            type: string
        expiry:
          $ref: '#/components/schemas/QueueExpiry'
        createdBy:
          type: integer
          format: int64
          description: ID of the user who created this queue
        createdOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the queue was created
        updatedBy:
          type: integer
          format: int64
          description: ID of the user who last modified this queue
        updatedOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp of the last modification
        version:
          type: integer
          description: Optimistic locking version number
    QueueMember:
      type: object
      description: A user with membership access to a queue
      properties:
        userId:
          type: integer
          format: int64
          description: ID of the queue member user
        role:
          type: string
          description: Membership role of the user in this queue
    QueueParticipantRequest:
      type: object
      description: Request to add a participant to a queue
      properties:
        userId:
          type: integer
          format: int64
          description: ID of the user to add as a participant
    Error:
      type: object
      description: Standard error response
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Human-readable error description
  parameters:
    UserIdParam:
      name: userId
      in: path
      required: true
      description: Unique numeric identifier of the user
      schema:
        type: integer
        format: int64
    QueueIdParam:
      name: id
      in: path
      required: true
      description: Unique numeric identifier of the queue
      schema:
        type: integer
        format: int64
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from the Authentication API
    xAuthorization:
      type: apiKey
      in: header
      name: X-Authorization
      description: JWT token obtained from the Authentication API, passed as X-Authorization header
externalDocs:
  description: Automation Anywhere Workload Management API v4 Documentation
  url: https://docs.automationanywhere.com/bundle/enterprise-v2019/page/wlm-api-supported-v4.html

automation-anywhere Queues API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification