No results

Items

Items are basically just JSON documents with a bit of metadata attached. They are stored in lists which allow them to be grouped together, sorted, filtered and so on.

Items have a version number which is automatically incremented when the item is updated. Items can be restored to a previous version at any time, and when viewing an item you can request a specific version of the item.

When fetching an item in a list, we can refer to the item either by its id, or if the list has an alias index defined, we can refer to the item by its alias value.

Item object

{
id: "f6f2c044-d951-4c67-83d8-435762123884"
createdAt: "2026-09-05T11:29:50.896Z"
updatedAt: "2026-09-05T11:29:50.896Z"
data: {
name: "John Doe"
age: 30
locations: [
0: {
city: "New York"
state: "NY"
}
1: {
city: "Los Angeles"
state: "CA"
}
]
}
description: "Sample item description"
version: "1"
readonly: false
activated: true
size: 12
}
  • idstringUnique identifier for the item.
  • createdAtstringDate and time the item was created in ISO 8601 format.
  • updatedAtstringDate and time the item was last updated in ISO 8601 format.
  • dataanyThe item's data.
  • descriptionstringA description of the item.
  • versionstring

    The item's current version.

    By default this will start out as "1" and increment naturally (e.g. "2", "3", and so on), however you can set this to practically any version number format and it will be incremented accordingly.

    Examples
    • "" (empty string) will be incremented to "1".
    • 1 will be incremented to 2.
    • 0.12 will be incremented to 0.13.
    • 0.1.0 will be incremented to 0.1.1.
    • 0.1.0b will be incremented to 0.1.1b.
    • 4test123 will be incremented to 4test124.
  • readonlybooleanWhether the item is read-only.
  • activatedbooleanWhether the item is activated. Inactive items are not accessible via the API.
  • sizenumberThe size of the item's data, measured in bytes.
2024-10-29