Get an Index

Deprecated

GET /v9/index/(indexId)

Retrieves information about a single index.

Info

• You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )

Path Parameters

Parameter	Data Type	Description
indexId	string	The id of the index (case-insensitive).

Response Body

Info 🔗︎ object

Info

Information explaining the outcome of the transaction.

---

Info properties

Code 🔗︎ string

Code

Code	Description
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

Message 🔗︎ string

Message

This message further describes the code providing additional detail.

Value 🔗︎ object

Value

Contains response data for the transaction.

---

Value properties

OwnerId 🔗︎ string

OwnerId

The account id of the index owner.

Name 🔗︎ string

Name

The name of the index.

IndexType 🔗︎ string

IndexType

The type of the index. One of:

• Resume
• Job

Sample JSON

{
  "Info": {
    "Code": "string",
    "Message": "string"
  },
  "Value": {
    "OwnerId": "",
    "Name": "",
    "IndexType": ""
  }
}