Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Get All Indexes

GET /v9/index

Retrieves information about all the indexes associated with your account. See Standard Transaction Cost

Names

  • You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
  • There should never be a need to call this endpoint. You should be keeping track of what indexes you have created and deleted. Adding a document to an index that doesn't exist will return a 404 - Not Found error.

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided

Unauthorized - Your account doesn't have permission to perform this operation

DataNotFound - Data with the specified name wasn't found
Info.Messagestring
This message further describes the code providing additional detail.
Valueobject[]
Contains response data for the transaction.
Value[i].OwnerIdstring
The account id of the index owner.
Value[i].Namestring
The name of the index.
Value[i].IndexTypestring
The type of the index. One of:
  • Resume
  • Job

Sample Response

{ ... 
{ ... 
"Code" :  "string","Message" :  "string"
},
[ ... 
{
"OwnerId" :  "","Name" :  "","IndexType" :  ""
}
]
}