Indexes

Indexes are used to efficiently search, sort, and filter items in a list. Each index points to a specific field in the item data using JSON pointer syntax.

Indexes can be given a valueType which allows items to be sorted and filtered in different ways, for example as numbers or dates.

Also, indexes can be marked as an "alias index" (only one alias index per list) which allows us to refer to items by the value of the alias index field.

Index object

{id: "5ae65465-37c7-4cc4-97bc-479bcd32e5be"
createdAt: "2026-09-23T21:08:31.622Z"
updatedAt: "2026-09-23T21:08:31.622Z"
name: "Sample Index"
description: ""
tags: [0: "my-app"
]
pathName: "sample-index"
pointer: "/name"
valueType: "string"
alias: false
sorting: false
filtering: false
searching: false
guard: false
defaultOrderDirection: "asc"
activated: true
buildStatus: "ready"
}

idstringUnique identifier for the index.
createdAtstringDate and time the index was created in ISO 8601 format.
updatedAtstringDate and time the index was last updated in ISO 8601 format.
namestringThe name of the index.
descriptionstringA description of the index.
tagsstring[]
Tags for grouping related resources together, e.g. ["recipe-app", "production"].
pathNamestringThe path name of the index. This is used in URL query parameters to sort and filter items.
pointerstringA JSON pointer to the field in the item data that the index points to.
valueType'string' | 'number' | 'date'
The type of value that the index points to.
This can be used to sort and filter items in different ways.
Examples
- ?index-name=lt:10 will filter items using the index-name index where the indexed value is a number less than 10.
- ?index-name=lte:10 will filter items using the index-name index where the indexed value is a number less than or equal to 10.
- ?index-name=gt:10 will filter items using the index-name index where the indexed value is a number greater than 10.
- ?index-name=gte:10 will filter items using the index-name index where the indexed value is a number greater than or equal to 10.
- ?index-name=before:2026-09-23 will filter items using the index-name index where the indexed value is a date before (or exactly equal to) 23rd September 2026.
- ?index-name=after:2026-09-23 will filter items using the index-name index where the indexed value is a date after (or exactly equal to) 23rd September 2026.
aliasbooleanWhether the index is an alias index. Each list can only have one alias index.
sortingbooleanWhether the index can be used for sorting items.
filteringbooleanWhether the index can be used for filtering items.
searchingbooleanWhether the index can be used for searching for items.
guardboolean
Whether the value at the index pointer is hidden from item data in token auth mode. The value can still be written.
A guard index can't also be an alias index, or be used for sorting, filtering or searching, because each of those would expose the value it hides.
defaultOrderDirection'asc' | 'desc'When sorting items using this index, this is the default order direction.
activatedbooleanWhether the item is activated. Inactive indexes are not accessible or usable via the API.
buildStatus'ready' | 'building' | 'failed'
Whether the index's values have been built. An index is built in the background when it's created and when its pointer changes.
Requests that depend on the index's values (filtering, ordering, alias lookups and search) are refused until it's ready. See index builds.

2026-09-13