DocsRecords
Records are the data entries within a collection. Learn how to create, read, update, delete, and query records with filters, sorting, and pagination.
Records are individual data entries within a collection — similar to rows in a database table. Each record contains values for the fields defined in the collection schema.
Creating records
To create a record, provide values for the collection's fields. Required fields must have values. Fields with defaults will use the default value if not specified.
Fields are validated on creation:
- Type checking (text, number, date, etc.)
- Required field enforcement
- Validation rule evaluation (min/max, patterns, etc.)
- Link field reference verification
Reading records
Get a single record
Retrieve a record by its ID within a collection. The response includes all field values for the record.
List records
List records in a collection with support for:
| Feature | Description |
|---|---|
| Filters | Narrow results by field values (equals, contains, greater than, etc.) |
| Sorting | Order results by one or more fields (ascending or descending) |
| Pagination | Retrieve results in pages with configurable page size |
| Search | Full-text search across text fields |
| Field selection | Specify which fields to include in the response |
Filtering
Filters support a range of comparison operators:
| Operator | Description | Example |
|---|---|---|
| equals | Exact match | status equals "active" |
| not_equals | Not equal | status not_equals "archived" |
| contains | Text contains substring | name contains "John" |
| greater_than | Numeric/date comparison | amount greater_than 100 |
| less_than | Numeric/date comparison | created_at less_than "2025-01-01" |
| is_empty | Field has no value | email is_empty |
| is_not_empty | Field has a value | email is_not_empty |
Filters can be combined with AND/OR logic for complex queries.
Linked record expansion
When a collection has link fields, listing records can automatically JOIN and return data from the linked collection. This lets you retrieve related data in a single query — for example, fetching a customer record along with their associated orders.
Updating records
Update a record by providing the fields and values to change. Only the specified fields are modified — other fields retain their current values.
Validation rules are re-evaluated on update.
Deleting records
Delete a record by its ID. Deletion removes the record and its values from the collection. Link references from other records to the deleted record may need to be handled depending on the relationship configuration.
Batch operations
For efficiency, the platform supports batch operations:
- Batch create — insert multiple records in a single request
- Batch update — update multiple records at once
- Batch delete — remove multiple records in a single request
Batch operations are transactional — if any record in the batch fails validation, the entire batch is rejected.
Data isolation
Records are isolated per organization. When an app is installed, each organization gets its own data store. Queries only return records belonging to the current organization.
Related concepts
- Fields and Types — the schema that defines record structure
- Views — saved query configurations
- Datasets — large-scale data storage for analytics and bulk data
Fields and Types
Collection fields define the schema of your data. Learn about the available field types, validation rules, and configuration options.
Views
Views are saved query configurations for collections — defining which fields are visible, how records are filtered, and in what order they appear.