Required ACL: addObject, deleteIndex, editSettingsYour Algolia application ID.
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.
Number of items per page.
Required range: 1 <= x <= 100
Sort order of the response, ascending or descending.
Ascending or descending sort order.
Available options:
asc,
desc
Page number of the paginated API response.
Page of the API response to retrieve.
Required range: x >= 1
platform
enum<string> · null · enum<string>[]
Ecommerce platform for which to retrieve authentications.
Name of an ecommerce platform with which to authenticate.
This determines which authentication type you can select.
Available options:
bigcommerce,
commercetools,
shopify
sort
enum<string>
default:createdAt
Property by which to sort the list of authentications.
Available options:
name,
type,
platform,
updatedAt,
createdAt
Type of authentication resource to retrieve.
Type of authentication. This determines the type of credentials required in the input object.
Available options:
googleServiceAccount,
basic,
apiKey,
oauth,
algolia,
algoliaInsights,
secrets
Last modified on March 23, 2026