Api reference
List documents
Returns paginated documents from the index. Pass q=* (default) to browse all documents, or a search query to filter results. Requires search scope.
Returns paginated documents from the index. Pass q=* (default) to browse all documents, or a search query to filter results. Requires search scope.
Authorization
BearerAuth AuthorizationBearer <token>
Search API key (ss_search_*) from the dashboard or keys API. Scopes (search, ingest, admin) are stored on the key; each route requires the matching scope.
In: header
Path Parameters
indexId*string
Query Parameters
q?string
Search query. Use * to return all documents.
Default
"*"page?integer
Default
1Range
1 <= valueperPage?integer
Default
20Range
1 <= value <= 250filterBy?string
Typesense filter expression (e.g. 'price:>100').
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://loading/api/v1/indexes/string/documents"{
"hits": [],
"found": 0,
"page": 0,
"perPage": 0
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}Empty