Skip to main

API Technical Specs

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

Get an Index

Deprecated GET /v9/index/(indexId)

Retrieves information about a single index.

Notes

Path Parameters

ParameterData TypeDescription
indexIdstringThe id of the index (case-insensitive).

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.OwnerIdstring
The account id of the index owner.
Value.Namestring
The name of the index.
Value.IndexTypestring
The type of the index. One of:
  • Resume
  • Job

Sample Response

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