Skip to content

List Library Documents

GET
/library/documents

What is in the library.

Authorizations

Parameters

Query Parameters

context_type

Whose library to read. campaign and account additionally need the matching id below; without it the app reads the GLOBAL library, which is a different set of documents rather than an error.

string
default: global
Allowed values: global campaign account

Whose library to read. campaign and account additionally need the matching id below; without it the app reads the GLOBAL library, which is a different set of documents rather than an error.

campaign_id
Any of:
string

Campaign id. Only read when context_type is campaign.

account_id
Any of:
string

Account id. Only read when context_type is account.

folder_path
Any of:
string

Only this folder.

include_deleted

Include soft-deleted documents, which is how you find something to pass to /documents/{id}/restore.

boolean

Include soft-deleted documents, which is how you find something to pass to /documents/{id}/restore.

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.

items is always present and always the list, whichever key the app used for it - so a caller can page one way rather than learning six key names.

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