Skip to main content
GET
List Sailboxes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:50

How many Sailboxes to return.

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

How many Sailboxes to skip before the page starts.

Required range: 0 <= x <= 100000
app
string

Only return Sailboxes in this app id.

status
string

Only return Sailboxes in this status. failed also returns create_failed and interrupted_unsafe_to_retry.

exclude_status
string

Leave out Sailboxes in any of these statuses, written as a comma-separated list. Each name is matched exactly, so failed here leaves out only failed.

Only return Sailboxes matching this text. It is matched against the Sailbox name and id and against the name and id of the app it belongs to.

manageable_by_caller
boolean
default:false

Only return Sailboxes this key can operate without an owner override. A private Sailbox someone else created is left out even for an organization admin.

order
enum<string>
default:newest_active

newest_active groups by state, most recently changed first within each group: running and creating, then paused, sleeping, and interrupted_restorable, then failed, create_failed, and interrupted_unsafe_to_retry, then everything else. newest_created sorts purely by creation time.

Available options:
newest_active,
newest_created,

Response

A page of Sailboxes.

data
object[]
required

The requested page of Sailboxes.

limit
integer
required

Page size that was applied.

offset
integer
required

Offset that was applied.

total
integer
required

Total number of Sailboxes matching the filters.

has_more
boolean
required

Whether another page follows this one.