Get indexed documents for a specific index

Returns all the indexed documents for that index

get/v2/index/{name}/documents

Request

Base URL
https://api.affinda.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/affinda/apis/affinda-api/docs/v2/index/:name/documents/get.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

Unique index name

Example:all-resumes

Index name

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

{
  "count": 1
}

No recorded changes to this operation across all 1 revision of this API.