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 | Collection attributes. Can be one of:AttributeBoolean model, AttributeInteger model, AttributeFloat model, AttributeEmail model, AttributeEnum model, AttributeURL model, AttributeIP model, AttributeDatetime model, AttributeRelationship model, AttributePoint model, AttributeLine model, AttributePolygon model, AttributeVarchar model, AttributeText model, AttributeMediumtext model, AttributeLongtext model, AttributeString model |
indexes | array | Collection indexes. Can be one of: |
bytesMax | integer | Maximum document size in bytes. Returns 0 when no limit applies. |
bytesUsed | integer | Currently used document size in bytes based on defined attributes. |
Example
{
"$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": {},
"indexes": {},
"bytesMax": 65535,
"bytesUsed": 1500
}
{
"_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": {},
"indexes": {},
"bytesMax": 65535,
"bytesUsed": 1500
}