Skip to main content
POST
/
1
/
transformations
/
search
curl
curl --request POST \
  --url https://data.us.algolia.com/1/transformations/search \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"transformationIDs":["6c02aeb1-775e-418e-870b-1faccd4b2c0f"]}'
[
  {
    "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>"
  }
]
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.

Body

application/json
​
transformationIDs
string[]
required

Universally unique identifier (UUID) of a transformation.

Response

OK

​
transformationID
string
required

Universally unique identifier (UUID) of a transformation.

Example:

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

​
code
string
required
deprecated

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

​
name
string
required

The uniquely identified name of your transformation.

​
createdAt
string
required

Date of creation in RFC 3339 format.

​
updatedAt
string
required

Date of last update in RFC 3339 format.

​
authenticationIDs
string[]

The authentications associated with the current transformation.

Universally unique identifier (UUID) of an authentication resource.

​
type
enum<string>

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

Available options:
code,
noCode
​
input
object

The input for the transformation, which can be either code or a no-code configuration. Input for a transformation that contains the source code of the transformation.

  • Option 1
  • Option 2
​
description
string

A descriptive name for your transformation of what it does.

​
owner
string | null

Owner of the resource.

⌘I