Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

API key

Path Parameters

agent_id
string<uuid>
required
batch_id
string<uuid>
required

Query Parameters

cursor
string

The pagination cursor value.

pageSize
integer

Number of results to return per page.

status
enum<string>
  • FUTURE - FUTURE
  • PENDING - PENDING
  • SUCCESS - SUCCESS
  • EXPIRED - EXPIRED
  • ERROR - ERROR
Available options:
FUTURE,
PENDING,
SUCCESS,
EXPIRED,
ERROR
Minimum string length: 1

Response

200 - application/json
results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"

total
integer
Example:

123