List Collections

post/listcollections

List all existing Collections.

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json
required

ListCollections request

allowedDatasource
string

The datasource type this Collection can hold. ANSWERS - for Collections representing answer boards

includeAudience
boolean

Whether to include the audience filters with the listed Collections.

includeRoles
boolean

Whether to include the editor roles with the listed Collections.

Responses
200

OK

Response Schema: application/json
required
Array of objects (Collection)

List of all Collections, no Collection items are fetched.

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "includeAudience": true,
  • "includeRoles": true,
  • "allowedDatasource": "string"
}
Response samples
application/json
{
  • "collections": [
    • {
      • "name": "string",
      • "description": "string",
      • "addedRoles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ],
      • "removedRoles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ],
      • "audienceFilters": [
        • {
          • "fieldName": "type",
          • "values": [
            • {
              • "value": "Spreadsheet",
              • "relationType": "EQUALS"
              },
            • {
              • "value": "Presentation",
              • "relationType": "EQUALS"
              }
            ]
          }
        ],
      • "icon": "string",
      • "adminLocked": true,
      • "parentId": 0,
      • "thumbnail": {
        • "photoId": "string",
        • "url": "string"
        },
      • "allowedDatasource": "string",
      • "permissions": {
        • "write": {
          • "scopeType": "GLOBAL",
          • "create": true,
          • "update": true,
          • "delete": true
          }
        },
      • "id": 0,
      • "createTime": "2019-08-24T14:15:22Z",
      • "updateTime": "2019-08-24T14:15:22Z",
      • "creator": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "updatedBy": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "itemCount": 0,
      • "childCount": 0,
      • "items": [
        • {
          • "name": "string",
          • "description": "string",
          • "icon": "string",
          • "collectionId": 0,
          • "documentId": "string",
          • "url": "string",
          • "itemId": "string",
          • "createdBy": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "createdAt": "2019-08-24T14:15:22Z",
          • "document": {
            • "id": "string",
            • "datasource": "string",
            • "connectorType": "API_CRAWL",
            • "docType": "string",
            • "content": {
              • "fullTextList": [
                • null
                ]
              },
            • "containerDocument": { },
            • "parentDocument": { },
            • "title": "string",
            • "url": "string",
            • "metadata": {
              • "container": "container",
              • "parentId": "JIRA_EN-1337",
              • "createTime": "2000-01-23T04:56:07.000Z",
              • "datasource": "datasource",
              • "author": {
                • "name": "name"
                },
              • "documentId": "documentId",
              • "updateTime": "2000-01-23T04:56:07.000Z",
              • "mimeType": "mimeType",
              • "objectType": "Feature Request",
              • "components": [
                • "Backend",
                • "Networking"
                ],
              • "status": [
                • "Done"
                ],
              • "customData": {
                • "someCustomField": "someCustomValue"
                }
              },
            • "sections": [
              • {
                • "title": null,
                • "url": null
                }
              ]
            },
          • "shortcut": {
            • "id": 0,
            • "inputAlias": "string",
            • "destinationUrl": "string",
            • "destinationDocumentId": "string",
            • "description": "string",
            • "unlisted": true,
            • "urlTemplate": "string",
            • "addedRoles": [
              • {
                • "sourceDocumentSpec": null,
                • "person": null,
                • "group": null,
                • "role": null
                }
              ],
            • "removedRoles": [
              • {
                • "sourceDocumentSpec": null,
                • "person": null,
                • "group": null,
                • "role": null
                }
              ],
            • "permissions": {
              • "write": {
                • "scopeType": null,
                • "create": null,
                • "update": null,
                • "delete": null
                }
              },
            • "createdBy": {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              },
            • "createTime": "2019-08-24T14:15:22Z",
            • "updatedBy": {
              • "name": "George Clooney",
              • "obfuscatedId": "abc123"
              },
            • "updateTime": "2019-08-24T14:15:22Z",
            • "destinationDocument": {
              • "id": "string",
              • "datasource": "string",
              • "connectorType": "API_CRAWL",
              • "docType": "string",
              • "content": {
                • "fullTextList": [ ]
                },
              • "containerDocument": { },
              • "parentDocument": { },
              • "title": "string",
              • "url": "string",
              • "metadata": {
                • "container": "container",
                • "parentId": "JIRA_EN-1337",
                • "createTime": "2000-01-23T04:56:07.000Z",
                • "datasource": "datasource",
                • "author": {
                  • "name": "name"
                  },
                • "documentId": "documentId",
                • "updateTime": "2000-01-23T04:56:07.000Z",
                • "mimeType": "mimeType",
                • "objectType": "Feature Request",
                • "components": [
                  • "Backend",
                  • "Networking"
                  ],
                • "status": [
                  • "Done"
                  ],
                • "customData": {
                  • "someCustomField": "someCustomValue"
                  }
                },
              • "sections": [
                • null
                ]
              },
            • "intermediateUrl": "string",
            • "viewPrefix": "string",
            • "isExternal": true,
            • "editUrl": "string",
            • "alias": "string",
            • "title": "string",
            • "roles": [
              • {
                • "sourceDocumentSpec": null,
                • "person": null,
                • "group": null,
                • "role": null
                }
              ]
            },
          • "collection": null,
          • "itemType": "DOCUMENT"
          }
        ],
      • "pinMetadata": {
        • "existingPins": [
          • {
            • "category": "COMPANY_RESOURCE",
            • "value": "string",
            • "target": "RESOURCE_CARD"
            }
          ],
        • "eligiblePins": [
          • {
            • "id": 0,
            • "target": {
              • "category": "COMPANY_RESOURCE",
              • "value": "string",
              • "target": "RESOURCE_CARD"
              }
            }
          ]
        },
      • "shortcuts": [
        • "string"
        ],
      • "children": [
        • null
        ],
      • "roles": [
        • {
          • "sourceDocumentSpec": {
            • "url": "string"
            },
          • "person": {
            • "name": "George Clooney",
            • "obfuscatedId": "abc123"
            },
          • "group": {
            • "type": "DEPARTMENT",
            • "id": "string",
            • "name": "string"
            },
          • "role": "OWNER"
          }
        ]
      }
    ]
}