Collections

Read Collection

Changed on Oct 5, 2026

Read the details of a Collection given its ID. Does not fetch items in this Collection.

post/rest/api/v1/getcollection

Request

Base URL: https://instance-name-be.glean.com
URL: https://instance-name-be.glean.com/rest/api/v1/getcollection
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

idinteger required

The ID of the Collection to be retrieved.

withItemsboolean

Whether or not to include the Collection Items in this Collection. Only request if absolutely required, as this is expensive.

withHierarchyboolean

Whether or not to include the top level Collection in this Collection's hierarchy.

allowedDatasourcestring

The datasource allowed in the Collection returned.

Response

trackingTokenstring

Use collection.trackingToken instead.

Example response

{
  "collection": {
    "addedRoles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ],
    "removedRoles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ],
    "audienceFilters": [
      {
        "fieldName": "type",
        "values": [
          {
            "value": "Spreadsheet",
            "relationType": "EQUALS"
          },
          {
            "value": "Presentation",
            "relationType": "EQUALS"
          }
        ]
      }
    ],
    "creator": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "updatedBy": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "items": [
      {
        "createdBy": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        },
        "document": {
          "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": {
                "stringValue": "someCustomValue"
              }
            }
          }
        },
        "shortcut": {
          "addedRoles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ],
          "removedRoles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ],
          "createdBy": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "updatedBy": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "destinationDocument": {
            "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": {
                  "stringValue": "someCustomValue"
                }
              }
            }
          },
          "roles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ]
        }
      }
    ],
    "roles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ]
  },
  "rootCollection": {
    "addedRoles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ],
    "removedRoles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ],
    "audienceFilters": [
      {
        "fieldName": "type",
        "values": [
          {
            "value": "Spreadsheet",
            "relationType": "EQUALS"
          },
          {
            "value": "Presentation",
            "relationType": "EQUALS"
          }
        ]
      }
    ],
    "creator": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "updatedBy": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "items": [
      {
        "createdBy": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        },
        "document": {
          "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": {
                "stringValue": "someCustomValue"
              }
            }
          }
        },
        "shortcut": {
          "addedRoles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ],
          "removedRoles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ],
          "createdBy": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "updatedBy": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "destinationDocument": {
            "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": {
                  "stringValue": "someCustomValue"
                }
              }
            }
          },
          "roles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ]
        }
      }
    ],
    "roles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ]
  }
}

Changes

Oct 5, 2026cfa377371200 Revision 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
- 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
Oct 2, 20263c36e7c6aa0c Revision changes
- warning
  added the new VIDEO_TYPE enum value to the ///////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ///////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the /// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ////////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ////////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the /////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ///////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ///////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the /// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ////////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ////////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the /////////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the ////////////// response property for the response status
- warning
  added the new VIDEO_TYPE enum value to the //////////// response property for the response 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
- 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
- info
  added the optional property /// to the response with the status

Operation history (6 revisions)