v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB
Search & Match - Indexing

Get list of all indexes

Returns all the indexes

get/v2/index

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": {
        "name": "Carl Johnson",
        "email": "carljohnson@grove.street",
        "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
      }
    }
  ]
}