GET /1/indexes/{indexName}/{objectID}

Retrieves one record by its object ID.

To retrieve more than one record, use the objects operation.

Servers

Path parameters

Name Type Required Description
indexName String Yes

Name of the index on which to perform the operation.

objectID String Yes

Unique record identifier.

Query parameters

Name Type Required Description
attributesToRetrieve[] Array No

Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.

objectID is always retrieved.

Attributes included in unretrievableAttributes won't be retrieved unless the request is authenticated with the admin API key.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.