Collections

List Collections

Changed on

List all existing Collections.

post/rest/api/v1/listcollections

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/listcollections
  • Auth: HTTP bearer

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Headers

X-Glean-ActAsstring email

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

X-Glean-Auth-Typestring

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

Request body

querystring

Case-insensitive substring search on collection names. Leading and trailing whitespace is ignored. An empty query does not filter collections.

includeAudienceboolean

Whether to include the audience filters with the listed Collections.

includeRolesboolean

Whether to include the editor roles with the listed Collections.

allowedDatasourcestring

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

Response

OK

Changes

  • c5d1ab774039Revision changes
    • info

      added the new optional request property

  • cfa377371200Revision 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

    • 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