Skip to main content
GET
/
v3
/
index
Get list of all indexes
curl --request GET \
  --url https://{region}.affinda.com/v3/index \
  --header 'Authorization: Bearer <token>'
{
  "count": 10,
  "results": [
    {
      "name": "my-index",
      "docType": "resumes",
      "user": {
        "id": 1,
        "name": "Carl Johnson",
        "email": "[email protected]",
        "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
      }
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

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.

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

​
document_type
enum<string>

Filter indices by a document type

Available options:
resumes,
job_descriptions
​
name
string

Filter indices by name

Response

All indexes for user

​
count
integer
required

Number of items in results.

Required range: x >= 0
Example:

10

​
results
object[]
required
​
next
string | null

URL to request next page of results.

​
previous
string | null

URL to request previous page of results.