Skip to main content
GET
/
1
/
authentications
curl
curl --request GET \
  --url 'https://data.us.algolia.com/1/authentications?itemsPerPage=10&page=1&type=basic%2Coauth&platform=commercetools%2Cnone&sort=createdAt&order=desc' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "authentications": [
    {
      "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "createdAt": "<string>",
      "input": {
        "clientEmail": "service-account-name@project-id.iam.gserviceaccount.com",
        "privateKey": "<string>"
      },
      "name": "<string>",
      "updatedAt": "<string>",
      "owner": "<string>"
    }
  ],
  "pagination": {
    "itemsPerPage": 10,
    "nbItems": 1,
    "nbPages": 2,
    "page": 2
  }
}
Required ACL: addObject, deleteIndex, editSettings

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.

Query Parameters

​
itemsPerPage
integer
default:10

Number of items per page.

Required range: 1 <= x <= 100
​
order
enum<string>
default:desc

Sort order of the response, ascending or descending. Ascending or descending sort order.

Available options:
asc,
desc
​
page
integer

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
Example:

"commercetools,none"

​
sort
enum<string>
default:createdAt

Property by which to sort the list of authentications.

Available options:
name,
type,
platform,
updatedAt,
createdAt
​
type
enum<string>[]

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
Example:

"basic,oauth"

Response

OK

​
authentications
object[]
required
​
pagination
object
required

Paginated API response.

Last modified on March 23, 2026