No results

Lists

Lists are used to store and manage a collection of items. They are similar to a table in a relational database, or to a folder in a file system.

You can optionally define a schema for a list, which will enforce the structure of the items in the list.

Lists can also have indexes, which allow the items in the list to be searched, sorted and filtered efficiently.

List object

{
id: "3230a9e8-fd7a-463a-9c52-61eef4176d4a"
createdAt: "2026-09-05T11:29:36.913Z"
updatedAt: "2026-09-05T11:29:36.913Z"
user: {
id: "4da36b08-5229-4b99-9739-49399263bb2d"
createdAt: "2026-09-05T11:29:36.913Z"
updatedAt: "2026-09-05T11:29:36.913Z"
lastActiveAt: "2026-09-05T11:29:36.913Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
name: "Sample List"
description: "Sample list description"
pathName: "sample-list"
schema: null
pinned: false
readonly: false
realtime: false
protected: false
indexable: true
activated: true
itemCount: 0
}
  • idstringUnique identifier for the list.
  • createdAtstringDate and time the list was created in ISO 8601 format.
  • updatedAtstringDate and time the list was last updated in ISO 8601 format.
  • userobjectThe user who created the list.
    User attributes
    • idstringUnique identifier for the user.
    • createdAtstringDate and time the user registered in ISO 8601 format.
    • updatedAtstringDate and time the user was last updated in ISO 8601 format.
    • lastActiveAtstringDate and time the user was last active in ISO 8601 format.
    • activatedbooleanWhether the user account is activated.
    • displayNamestringThe user's display name.
    • descriptionstringThe user's description.
  • namestringThe name of the list.
  • descriptionstringA description of the list.
  • pathNamestringThe path name of the list. This can be used instead of the id in URLs.
  • schemanullable object

    The schema of the list. When items are created or modified in this list, we will check their data against this schema.

    This uses the JSON Schema format. It will be null if the list has no schema.

  • pinnedbooleanWhether the list is pinned to the dashboard menu for quick access.
  • readonlybooleanWhether the list is read-only. This affects the list and all items contained within it.
  • realtimebooleanWhether realtime updates are enabled for this list. If this is enabled, the list will emit events when it is modified or deleted, and when items are created, updated or deleted within it.
  • protectedbooleanWhether the list is protected. Protected lists cannot be deleted if they contain any items.
  • indexablebooleanWhether the list is indexable. We cannot view a list of items in a non-indexable list. Also, non-indexable lists cannot be searched.
  • activatedbooleanWhether the list is activated. Inactive lists are not accessible via the API.
  • itemCountnumberThe number of items in the list.
2024-10-29