UPupguard
trust_exchange

List content library documents

Changed on

Returns a paginated list of documents in the organization's content library.

Results are paginated. Use the page_size parameter to control how many results are returned per page. Use the next_page_token from the response to retrieve subsequent pages.

Required API key permissions: TrustExchange (select when creating API key in Account Settings)

get/trust_exchange/content_library/document/list

Request

Query parameters

page_sizeinteger

The number of results to return per page. Valid values range from 1 to 100. Defaults to 10 if not specified.

page_tokenstring

Token to retrieve a specific page of results. Omit to retrieve the first page. Use the next_page_token from the previous response to get the next page.

filter_namestring

Filter documents by name (substring match, case-insensitive).

filter_document_typesstring[]

Filter documents by document type names (set this param multiple times to specify multiple types).

filter_added_to_any_trust_centerboolean

Filter to only documents added to any Trust Center.

archivedboolean

Set to true to retrieve archived documents. By default, only non-archived documents are returned.

Response

List of content library documents.

next_page_tokenstring

The token used to fetch the next page of results, if there are more results.

Example response

{
  "documents": [
    {
      "created_at": "2024-03-20T15:30:00Z",
      "created_by_email": "jane@example.com",
      "created_by_name": "Jane Smith",
      "description": "Our latest SOC 2 Type II report covering the period...",
      "document_type": "SOC 2 Report",
      "internal_notes": "Document awaiting update...",
      "name": "Q4 2024 SOC 2 Report",
      "updated_at": "2024-03-20T15:30:00Z",
      "updated_by_email": "john@example.com",
      "updated_by_name": "John Doe",
      "usage_count": 5,
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "versions": [
        {
          "created_at": "2024-03-20T15:30:00Z",
          "filename": "soc2_report_q4_2024.pdf",
          "version": 3,
          "virus_safe": true
        }
      ]
    }
  ]
}

Changes