Skip to content

Collections Object

Relationships

Schema relationships 
graph LR
    Collections -->|"parent_collection_id"| Collections
    Collections -->|"workspace"| Workspaces

Properties

idstring
required·

The unique identifier for a collection

created_atstring · date-time

The date and time when the collection was created

descriptionstring

The description of the collection

entity_typestring

The type of entity that belongs to this collection

Possible values:
contactticket
etagstring

The unique identifier for the specific version of the resource.

namestring

The name of the collection

parent_collection_idstring

The parent collection id

References: Collections → id
remote_dataRecord<string, any>

Raw data returned from the remote API call.

typestring

The type of the collection

updated_atstring · date-time

The date and time when the collection was updated

urlsobject[]

The URLs of the collection

urlstring

The URL of the collection

workspaceobject
References: Workspaces → id
idstring

The unique identifier for a workspace

namestring

The name of the workspace