Sign in
latestOpenAPI 3.1.02026-08-10295186.7 KB

ec696334ff35

Orchestrations

List

List orchestrations. Results are sorted from most recent to oldest.

get/orchestrations/list

Query parameters

fromstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_from value returned in a previous response to request subsequent results.

limitinteger

A limit on the number of objects to be returned.

statusstring[]

Filter orchestrations by status.

typestring[]

Filter orchestrations by type. If not provided, all types are returned.

channelsstring[]

Filter orchestrations by channels. If not provided, all channels are returned.

Headers

X-Batch-Projectstring required

The unique project key, identifying a project on the Batch platform

Response

Successful response with a list of orchestrations.

countinteger

The total number of objects.

has_moreboolean

Whether or not there are more elements available after this set. If false, this set comprises the end of the list.

next_fromstring

A cursor for use in pagination. If has_more is true, you can pass the value of next_from to a subsequent call to fetch the next page of results.