Collection Object
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 | string[] | Collection permissions. Learn more about permissions. |
databaseId | string | Database ID. |
name | string | Collection name. |
enabled | boolean | Collection enabled. |
documentSecurity | boolean | Whether document-level permissions are enabled. Learn more about permissions. |
attributes | array of attributeBoolean attributeInteger attributeFloat attributeEmail attributeEnum attributeUrl attributeIp attributeDatetime attributeString | Collection attributes. |
indexes | index[] | Collection indexes. |
Examples
JSON
{
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"$permissions": [
"read(\"any\")"
],
"databaseId": "5e5ea5c16897e",
"name": "My Collection",
"enabled": false,
"documentSecurity": true,
"attributes": {
"key": "isEnabled",
"type": "boolean",
"status": "available",
"required": true,
"array": false,
"default": false
},
"indexes": {
"key": "index1",
"type": "primary",
"status": "available",
"attributes": [],
"orders": []
}
}