Skip to content

Collection

Properties

NAME TYPE DESCRIPTION
$id
string

Collection ID.

$createdAt
string

Collection creation date in ISO 8601 format.

$updatedAt
string

Collection update date in ISO 8601 format.

$permissions
array

Collection permissions. Learn more about permissions.

databaseId
string

Database ID.

name
string

Collection name.

enabled
boolean

Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.

documentSecurity
boolean

Whether document-level permissions are enabled. Learn more about permissions.

attributes
array
indexes
array

Collection indexes.

Can be one of:

Index model

Example