Retrieve records

Retrieves one or more records, potentially from different indices.

POST /1/indexes/*/objects

curl

cURL

curl --request POST \
  --url 'https://algolia_application_id.algolia.net/1/indexes/*/objects' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '
{
  "requests": [
    {
      "attributesToRetrieve": [
        "author",
        "title",
        "content"
      ],
      "objectID": "product-1",
      "indexName": "books"
    }
  ]
}
'

200

{
  "results": [
    {}
  ],
  "message": "Index INDEX_NAME does not exist."
}

Records are returned in the same order as the requests.

Required ACL: search

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Body

application/json

Request object.

Request parameters.

requests · getObjectsRequest · object[] · required

Show child attributes

Response

200

application/json

OK

results · object[] · required

Retrieved records.

message · string

An optional status message.

Example:

"Index INDEX_NAME does not exist."