Documents

List Library Documents

What is in the library.

get/library/documents

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/library/documents
  • Auth: HTTP bearer

Query parameters

context_type'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_idstring nullable

Campaign id. Only read when context_type is campaign.

account_idstring nullable

Account id. Only read when context_type is account.

folder_pathstring nullable

Only this folder.

include_deletedboolean

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

Changes

No recorded changes to this operation across all 3 revisions of this API.