Retrieve Items

Retrieves all items for the given key and section, paginated by num_results_per_page, optionally filtered by id -- multiple ids represent an OR request, returning results including any of the provided ids. If id is specified in the URL, returns just the item with that id.

curl -X GET -H "Content-Type: application/json" \
-u"[your token]:" \
"[your index key]&section=[section]"
curl -X GET -H "Content-Type: application/json" \
-u"[your token]:" \
"[your index key]&section=[section]&id=1&id=2"
curl -X GET -H "Content-Type: application/json" \
-u"[your token]:" \
"[your index key]&section=Products"

HTTP Requests#

GET[your index key]&section=[section]

GET[your index key]&section=[section]&id=[id]&id=[id]

GET[id]?key=[your index key]&section=[section]

Response format#

"items": [
"name": "[item_name]",
"suggested_score": "[item_score]",
"metadata": {[item_metadata]},
"id": "[item_id]",
"variations": [
"name": "[variation_name]",
"suggested_score": "[variation_score]",
"metadata": {[variation_metadata]},
"id": "[variation_id]",
"name": "[another_item_name]",
"suggested_score": "[another_item_score]",
"metadata": {[another_item_metadata]},
"id": "[another_item_id]"
"total_count": "[number_of_items]"

URL Parameters#

idThe id of the item you'd like to retrieve.

Query Parameters#

keyYesThe index you'd like to to retrieve results from.
sectionYesThe index section you'd like to retrieve results from.
idNoId(s) of items to return.
num_results_per_pageNoThe number of items to return. Defaults to 20. Maximum value 1,000.
pageNoThe page of results to return. Defaults to 1.