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

{
  "transformations": [
    {
      "transformationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "code": "<string>",
      "name": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "authenticationIDs": [
        "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
      ],
      "type": "code",
      "input": {
        "code": "<string>"
      },
      "description": "<string>",
      "owner": "<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. 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

order · enum<string> · default: desc

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

Available options: asc, desc

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.

transformations · object[] · required

Show child attributes

transformations. transformationID · string · required

Universally unique identifier (UUID) of a transformation.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

transformations. code · string · required · deprecated

It is deprecated. Use the input field with proper type instead to specify the transformation code.

transformations. name · string · required

The uniquely identified name of your transformation.

transformations. createdAt · string · required

Date of creation in RFC 3339 format.

transformations. updatedAt · string · required

Date of last update in RFC 3339 format.

transformations. authenticationIDs · string[]

The authentications associated with the current transformation.

Universally unique identifier (UUID) of an authentication resource.

transformations. type · enum<string>

The type of transformation, which can be either 'code' or 'noCode'.

Available options: code, noCode

transformations. input · Code · object

The input for the transformation, which can be either code or a no-code configuration.

Code

Show child attributes

transformations.input. code · string · required

The source code of the transformation.

transformations. description · string

A descriptive name for your transformation of what it does.

transformations. owner · string | null

Owner of the resource.

pagination · object · required

Paginated API response.

Show child attributes

pagination. nbPages · integer · required

Number of pages in the API response.

Required range: x >= 1

pagination. page · integer · required

Page of the API response to retrieve.

Required range: x >= 1

pagination. nbItems · integer · required

Number of items in the API response.

Required range: x >= 0

pagination. itemsPerPage · integer · default: 10 · required

Number of items per page.

Required range: 1 <= x <= 100