| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name |
Optional[str] | ➖ | The optional name of the Collection item. | |
description |
Optional[str] | ➖ | A helpful description of why this CollectionItem is in the Collection that it's in. | |
icon |
Optional[str] | ➖ | The emoji icon for this CollectionItem. Only used for Text type items. | |
collection_id |
int | ✔️ | The Collection ID of the Collection that this CollectionItem belongs in. | |
document_id |
Optional[str] | ➖ | If this CollectionItem is indexed, the Glean Document ID of that document. | |
url |
Optional[str] | ➖ | The URL of this CollectionItem. | |
item_id |
Optional[str] | ➖ | Unique identifier for the item within the Collection it belongs to. | |
created_by |
Optional[models.Person] | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
created_at |
date | ➖ | Unix timestamp for when the item was first added (in seconds since epoch UTC). | |
document |
Optional[models.Document] | ➖ | N/A | |
shortcut |
Optional[models.Shortcut] | ➖ | N/A | |
collection |
Optional[models.Collection] | ➖ | N/A | |
item_type |
models.CollectionItemItemType | ✔️ | N/A |