List transformations

Retrieves a list of transformations.

GET /1/transformations

curl

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'

200

{
  "pagination": {
    "itemsPerPage": 10,
    "nbItems": 1,
    "nbPages": 2,
    "page": 2
  },
  "transformations": [
    {
      "code": "<string>",
      "createdAt": "<string>",
      "name": "<string>",
      "transformationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "updatedAt": "<string>",
      "authenticationIDs": [
        "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
      ],
      "description": "<string>",
      "input": {
        "code": "<string>"
      },
      "owner": "<string>"
    }
  ]
}

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

sort · enum<string> · default: createdAt

Property by which to sort the list of transformations.

Available options: name, updatedAt, createdAt

type · enum<string>

Whether to filter the list of transformations by the type of transformation. The type of transformation, which can be either 'code' or 'noCode'.

Available options: code, noCode

Response

200

application/json

OK

Configured transformations and pagination information.

pagination · object · required

Paginated API response.

Show child attributes

transformations · object[] · required

Show child attributes