v1

latestOpenAPI 3.0.3MIT2026-08-04143307364.8 KB
Search & Match

Get indexed documents for a specific index

Returns all the indexed documents for that index

get/v3/index/{name}/documents

Path parameters

namestring required

Unique index name

Example:all-resumes

Index name

Query parameters

offsetinteger

The number of documents to skip before starting to collect the result set.

limitinteger
Example:20

The numbers of results to return.

Response

Successfully retrieved list of indexed documents

countinteger

Number of indexed documents in result

nextstring nullable

URL to request next page of results

previousstring nullable

URL to request previous page of results

Example response

{
  "count": 1
}