Skip to content

List Account Documents Batch

GET
/accounts/documents

Documents for MANY accounts in one call, grouped by account.

Account-native: it resolves ids across both the account and company id namespaces and folds workflow steps into the result. Scoped - an id the caller cannot see is dropped from the response rather than 403ing the whole batch.

Authorizations

Parameters

Query Parameters

account_ids
required

Comma-separated account ids. The batch ceiling is the app’s own.

string

Comma-separated account ids. The batch ceiling is the app’s own.

folder
Any of:
string

Only documents in this folder.

include_content

Include the full document bodies. Off by default because the payload grows by orders of magnitude when it is on.

boolean

Include the full document bodies. Off by default because the payload grows by orders of magnitude when it is on.

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.

Most of these handlers return a bare list[...]; a few return a named envelope ({"team_members": [...], "total": n}). Both are reachable as items, and a named envelope KEEPS its own key as well so a caller already reading the app’s shape is not broken by the wrapper.

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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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