Search a list

Search a list for items that match a query. Only values indexed by searchable list indexes will be used when searching for items.

GET https://api.jsonpad.io/lists/{listId}/search

Example

123

curl https://api.jsonpad.io/lists/610109af-667c-4e30-9fd4-aac6827142a4/search?query=example \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

required
listIdstringA list id or path name.
required
querystringhttps://api.jsonpad.io/lists/0c93155d-9af5-4ca8-b731-201412c5d017/search?query=exampleA search query.
optional
includeItemsbooleanhttps://api.jsonpad.io/lists/99192920-7762-4b33-bb97-ea5a5337c78b/search?includeItems=trueWhether items be included in the response or not. Can be true or false. If true, the response will include the items that match the query, otherwise we only include the item ids.
optional
includeDatabooleanhttps://api.jsonpad.io/lists/870753a3-6727-4d0e-a59d-ab5257f93352/search?includeData=trueWhether item data be included in the response or not. Can be true or false. Only used if includeItems is true.

Request headers

required
x-api-tokenstringYour API token.

Request body

No request body

Response body

200 OK

With includeItems set to false:

[0: {id: "3b759c5e-116b-452c-ae4e-93ffdf5420e4"
relevance: 0.19448714260648858
}
]

With includeItems set to true:

[0: {item: {id: "3b759c5e-116b-452c-ae4e-93ffdf5420e4"
createdAt: "2026-09-05T11:29:42.460Z"
updatedAt: "2026-09-05T11:29:42.460Z"
description: "This is a sample item"
readonly: false
activated: true
locked: false
dataSize: 13
}
relevance: 0.331265898416471
}
]

With both includeItems and includeData set to true:

[0: {item: {id: "3b759c5e-116b-452c-ae4e-93ffdf5420e4"
createdAt: "2026-09-05T11:29:42.460Z"
updatedAt: "2026-09-05T11:29:42.460Z"
description: "This is a sample item"
data: {test: 123
}
readonly: false
activated: true
locked: false
dataSize: 13
}
relevance: 0.290791145984974
}
]

Response headers

No response headers

2024-10-29