Skip to main content
GET
List queued commands

Authorizations

Authorization
string
header
required

API token created in the dashboard under Integrations > API. Tokens start with gci_.

Query Parameters

accountIdentifier
string

Exact delivery identifier, case-insensitive. Requires orders:buyer:read.

from
string<date-time>

Created at or after this instant (ISO-8601, UTC).

Example:

"2022-03-10T16:15:50.000Z"

orderId
string

Commands of this order.

page
integer<int32>
default:0

Zero-based page.

serverId
string<uuid>

Commands of this server.

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
size
integer<int32>
default:20

Items per page, 1 to 100.

status
enum<string>[]

Command statuses to include. Repeat the parameter for several.

Available options:
SCHEDULED,
PROCESSING,
EXECUTED,
FAILED,
UNCERTAIN
to
string<date-time>

Created before this instant (ISO-8601, UTC). Exclusive.

Example:

"2022-03-10T16:15:50.000Z"

Response

A page of commands.

currentPage
integer<int32>
items
object[]
pageSize
integer<int32>
totalItems
integer<int64>
totalPages
integer<int32>