Namespace
Folder

Get namespace folders

Changed on

Return a cursor-paginated page of folders at a location in the namespace library.

get/v1/organizations/{organizationRef}/namespaces/{namespaceRef}/folders

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}/namespaces/{namespaceRef}/folders
  • 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: namespace.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.

parent_idstring
Example:9bsv0s46s6s002p9ltq0

List folders located in this parent folder. Omit to list folders at the library root.

Response

OK

Example response

{
  "items": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "name": "Guides",
      "library": {
        "id": "9bsv0s46s6s002p9ltq0",
        "name": "Product"
      },
      "parent": {
        "id": "9bsv0s46s6s002p9ltq0",
        "name": "Guides",
        "parent_id": "9bsv0s46s6s002p9ltq0"
      },
      "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

  • 836ecb425096Revision changes
    • info

      endpoint added