v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
device_Operations

Get all Operations in the Tenant

Retrieves a paginated list of all Dispatch operations created within the tenant.

Use this endpoint to see every large-scale fleet operation issued through the Operations API, including Converge actions and group-level app installs and uninstalls, along with each operation's aggregate progress. Supports filtering by state, operation type, and group.

About Operations (Dispatch Commands)

Operations, also called Dispatch commands, are designed for large fleet actions that need to be issued once and tracked as a single unit rather than as many individual device commands. Currently supported operation types are CONVERGE and group-level app INSTALL and UNINSTALL (immediate only). Each operation moves through a lifecycle from Created through Dispatching, Dispatched, and Processing to a final Success or Failure, and this endpoint surfaces that lifecycle across every operation in the tenant.

Key Fields / Query Parameters

state — filters by operation state using integer codes, for example 10 for Created, 50 for Dispatched, 80 for Success, and 90 for Failure

operation_type — filters by type, for example CONVERGE, INSTALL, or UNINSTALL

group_multi — filters to operations targeting one or more group IDs and their subgroups

ordering — orders results by created_at, state, or updated_at; prefix with a minus sign to reverse order

Common Use Cases

Auditing every Converge operation issued across the tenant over a time period

Finding all operations currently stuck in a Dispatching or Processing state, which usually points to device connectivity issues

Filtering operations by group to review fleet actions scoped to a specific store or region

Best Practices

Filter by operation_type and state together to narrow large result sets before paging through them

Investigate operations that remain in Dispatched or Processing for an extended period, since this usually indicates devices are not picking up the command due to network issues

Use group_multi rather than fetching all operations and filtering client-side when working with group-scoped fleets

Workflow

Call this endpoint with the desired state or operation_type filters

Identify the operation of interest and note its id

Call GET /v0/operations/{operationId}/ for the full status and aggregate device counts

Drill into GET /v0/operations/{operationsId}/devices/ if the operation shows failures

get/v0/operations/

Query parameters

limitinteger
offsetinteger
stateinteger

Following are the Operation States and their corresponding integer values

OPERATION_CREATED      = 10
OPERATION_RESOLVING    = 20
OPERATION_RESOLVED     = 30
OPERATION_DISPATCHING  = 40
OPERATION_DISPATCHED   = 50
OPERATION_PROCESSING   = 60
OPERATION_COMPLETED    = 70
OPERATION_SUCCESS      = 80
OPERATION_FAILURE      = 90
OPERATION_SCHEDULED    = 100
OPERATION_CANCELLED    = 110
OPERATION_TIMEOUT      = 120
ordering'created_at' | 'state' | 'updated_at'

Field to order the results by. Prefix with '-' to reverse the order.

operation_typestring

Filter operations by type (e.g., INSTALL, UNINSTALL, CONVERGE, INSTALL_APP, UNINSTALL_APP, REBOOT)

group_multistring uuid

Filter by multiple group ID. Fetch the devices from groups matching with the IDs and its subgroup.

Response

Operations information for the Tenant