Organization
Document

Get organization documents

Changed on

Return a cursor-paginated page of documents in the organization library.

get/v1/organizations/{organizationRef}/documents

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}/documents
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization.read, document.read)

Query parameters

page_sizeinteger

Maximum number of items to return.

page_tokenstring

Opaque continuation token from a previous page_info.next_page_token.

folder_idstring
Example:9bsv0s46s6s002p9ltq0

Browse documents located in this folder. Omit to list unfiled documents at the library root.

allboolean

When true, return every document in the library regardless of folder.

Response

OK

Example response

{
  "items": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "title": "Project Plan",
      "excerpt": "Overview of the project plan",
      "created_by": {
        "id": "9bsv0s46s6s002p9ltq0",
        "first_name": "Test",
        "last_name": "User",
        "picture": "https://example.com/users/my-user.png"
      }
    }
  ]
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status