Skip to main content
GET
Get indexed documents for a specific index

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

name
string
required

Index name Unique index name

Example:

"all-resumes"

Query Parameters

offset
integer

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

Required range: x >= 0
Example:

0

limit
integer

The numbers of results to return.

Required range: 1 <= x <= 100
Example:

20

Response

Successfully retrieved list of indexed documents

count
integer

Number of indexed documents in result

Required range: x >= 1
Example:

1

next
string | null

URL to request next page of results

previous
string | null

URL to request previous page of results

results
object[]