GET
/
v1
/
transforms
Get Transforms
curl --request GET \
  --url https://api.runtrellis.com/v1/transforms \
  --header 'Authorization: <api-key>'
{
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "running",
      "proj_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_ran_at": "2023-11-07T05:31:56Z",
      "entity_type": "inbox",
      "params": {
        "transform_params": {}
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
API-Version
string

Pass in an API version to guarantee a consistent response format.

The latest version should be used for all new API calls. Existing API calls should be updated to the latest version when possible.

Valid versions:

  • Latest API version (recommended): 2025-03

  • Previous API version (maintenance mode): 2025-02

If no API version header is included, the response format is considered unstable and could change without notice (not recommended).

Query Parameters

​
search_term
string

Search term to filter transformations against their id and name.

​
transform_ids
string[]

List of transform IDs to retrieve.

​
proj_ids
string[]

List of project ids to retrieve transformations from.

​
include_transform_params
boolean
default:true

Boolean flag to include transform params, which includes the operations.

​
limit
integer
default:20
Required range: x > 0
​
offset
integer
default:0
Required range: x >= 0
​
order_by
enum<string>
default:updated_at

An enumeration.

Available options:
updated_at,
created_at,
id
​
order
enum<string>
default:desc

An enumeration.

Available options:
asc,
desc

Response

200
application/json

Successful Response

The response is of type object.