Skip to content

List Inbox Workspaces

GET
/inbox/workspaces

Inbox workspaces - the mailbox groupings a team works out of.

PLURAL here, though the app splits reads onto /workspace and the one write onto /workspaces. Two paths one letter apart do not belong in a public contract.

Authorizations

Parameters

Query Parameters

page
integer
default: 1 >= 1
page_size
integer
default: 20 >= 1 <= 100

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string