GET /1/indexes/{indexName}/{objectID}
Retrieves one record by its object ID.
To retrieve more than one record, use the objects
operation.
Servers
- https://{appId}.algolia.net
- https://{appId}-1.algolianet.com
- https://{appId}-2.algolianet.com
- https://{appId}-3.algolianet.com
- https://{appId}-dsn.algolia.net
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.
Attributes included in |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.