Skip to content

List converge action
Stable

Request

Retrieves a paginated list of Converge actions issued in the tenant.

Each record reflects a single device's Converge request, including which blueprint and version it targeted and its current aggregate status. Filter by device_ids to scope the list to specific devices.

About List Converge Actions

Converge is the mechanism that assigns a device to a blueprint and blueprint version and brings it into alignment with that configuration, covering apps, files, restrictions, and platform settings. Each Converge action moves through QUEUED, PROCESSING, IN_PROGRESS, and a terminal SUCCESS or FAILURE state as Esper applies the blueprint. This endpoint is the tenant-wide view of that activity, separate from the alpha Operations API, which handles Converge issued at fleet scale through POST /v0/operations/.

Key Fields / Query Parameters

device_ids — filters results to one or more device IDs, accepts comma-separated values

Common Use Cases

Reviewing the Converge history for a specific device

Auditing recent Converge activity across the tenant

Best Practices

Filter by device_ids when troubleshooting a specific device rather than paging through the full tenant-wide list

For large-scale Converge issued through the Operations API, use GET /v0/operations/ and its device-level endpoints instead of this list

Workflow

Call this endpoint with device_ids to scope to the devices you're investigating

Identify the converge id for the action you need

Call GET /v2/converge/{id} for full detail, or /v2/converge/{id}/commands to see the underlying commands it fired

Security
drift_apiKey
Query
device_idsstring

Filter by device IDs. Accepts comma separated values.

limitnumber
offsetnumber
cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v2/converge?device_ids=string&limit=0&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Converge action list for the Tenant

Bodyapplication/json
contentobject
Response
{
  "content": {
    "count": 0,
    "previous": "string",
    "next": "string",
    "results": [ … ]
  }
}