Skip to content

List the tenant's environment orders

View as Markdown
GET
/v1/environment-orders
curl --request GET \
--url 'https://example.com/v1/environment-orders?limit=25' \
--header 'Authorization: Bearer <token>'

The order a tenant runs a project through on its way to live — its environments: the tenant’s own order and each org’s. An order is listed when the caller can read a project in it; a project the caller can’t read is named by its position alone, without its id.

limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Where the previous page ended: its nextCursor, as it came. A runtime that seals cursors takes one only for the same list, filters and caller, within a day; otherwise 400 bad-input, and the list starts again without it. Absent → first page.

Page of environment orders.

Media typeapplication/json
object
data
required
Array<object>
object
parent
required
One of:
object
kind
required
string
Allowed values: tenant
entries
required
Array<object>
object
position
required
integer
projectId
string
hasMore
required
boolean
nextCursor
string
Example
{
"data": [
{
"parent": {
"kind": "tenant"
}
}
]
}

cursor isn’t one this list gave (bad-input).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}

See also