Skip to main content
GET
/
1
/
transformations
curl
curl --request GET \
  --url 'https://data.us.algolia.com/1/transformations?itemsPerPage=10&page=1&sort=createdAt&order=desc&type=code' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "transformations": [
    {
      "transformationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "authenticationIDs": [
        "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
      ],
      "code": "<string>",
      "type": "code",
      "input": {
        "code": "<string>"
      },
      "name": "<string>",
      "description": "<string>",
      "owner": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "pagination": {
    "nbPages": 2,
    "page": 2,
    "nbItems": 1,
    "itemsPerPage": 10
  }
}
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
​
page
integer

Page number of the paginated API response.

Required range: x >= 1
​
sort
enum<string>
default:createdAt

Property by which to sort the list of transformations.

Available options:
name,
updatedAt,
createdAt
​
order
enum<string>
default:desc

Sort order of the response, ascending or descending.

Available options:
asc,
desc
​
type
enum<string>

Whether to filter the list of transformations by the type of transformation.

Available options:
code,
noCode

Response

OK

Configured transformations and pagination information.

​
transformations
object[]
required
​
pagination
object
required

Paginated API response.