AFaffinda
Search & Match

Get list of all indexes

Changed on

Returns all the indexes

get/v3/index

Request

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.

document_type'resumes' | 'job_descriptions'

Filter indices by a document type

namestring

Filter indices by name

Response

All indexes for user

countinteger required

Number of items in results.

nextstring nullable

URL to request next page of results.

previousstring nullable

URL to request previous page of results.

Example response

{
  "count": 10,
  "results": [
    {
      "name": "my-index",
      "user": {
        "id": 1,
        "name": "Carl Johnson",
        "email": "carljohnson@grove.street",
        "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
      }
    }
  ]
}

Changes

  • 978cf99a2ac0Revision changes
    • info

      api tag Search & Match added

    • info

      api tag Search & Match API - Indexing removed

  • 0913ed9391cbRevision changes
    • breaking

      removed the required property /// from the response with the status

    • info

      added the required property /// to the response with the status