AFaffinda
Search & Match

Get indexed documents for a specific index

Changed on

Returns all the indexed documents for that index

get/v3/index/{name}/documents

Request

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
}

Changes

  • 978cf99a2ac0Revision changes
    • info

      api tag Search & Match added

    • info

      api tag Search & Match API - Indexing removed

  • 9b7d1081f5bcRevision changes
    • breaking

      for the query request parameter limit, default value 300 was removed

    • breaking

      for the query request parameter limit, the max was decreased from 300.00 to 100.00