No results

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: "0b163981-608d-4bac-aa52-2e0e46712506"
createdAt: "2026-09-05T11:30:16.009Z"
updatedAt: "2026-09-05T11:30:16.009Z"
name: "Sample Index"
description: ""
pathName: "sample-index"
pointer: "/name"
valueType: "string"
alias: false
sorting: false
filtering: false
searching: false
defaultOrderDirection: "asc"
activated: true
}
  • 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.
  • 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-05 will filter items using the index-name index where the indexed value is a date before (or exactly equal to) 5th September 2026.
    • ?index-name=after:2026-09-05 will filter items using the index-name index where the indexed value is a date after (or exactly equal to) 5th 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.
  • 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.
2024-10-29