Skip to main content
GET
List the accounts of a background run

Authorizations

X-API-Key
string
header
required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Path Parameters

batchId
string
required

Batch id returned by the revert call

Query Parameters

status
enum<string>

Only accounts in this state

Available options:
pending,
running,
succeeded,
failed,
cancelled
kind
enum<string>

Which background run of the batch: the revert or its undo. Default: the latest one.

Available options:
revert,
undo
limit
integer
default:100

Accounts per page

Required range: 1 <= x <= 1000
offset
integer
default:0

Accounts to skip

Required range: x >= 0

Response

Accounts of the run

success
boolean
Example:

true

data
object
Example: