Skip to main content
GET
List all inboxes

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication.

Query Parameters

key
string
limit
integer

Number of results to return per page.

name
string
offset
integer

The initial index from which to return the results.

status
enum<string>
  • initializing - initializing
  • active - active
  • paused - paused
  • deleting - deleting
  • initialization_failure - initialization_failure
Available options:
active,
deleting,
initialization_failure,
initializing,
paused

Response

An inbox: a durable, user-scoped queue for a trigger subscription, identified by its natural key.

count
integer
required

Total number of results across all pages.

Example:

123

results
object[]
required

Array of results for the current page.

next
string<uri> | null

Link to next page of results if any.

Example:

"https://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null

Link to previous page of results if any.

Example:

"https://api.example.org/accounts/?offset=200&limit=100"