Sign in

v1

latestOpenAPI 3.0.02026-08-0481631.4 KB
automation-connections

List automation connections

Retrieves a list of automation connections the requesting user has access to.

get/api/v1/automation-connections

Query parameters

cursorstring
Example:eyJpZCI6NDI4OTQ1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9

Pagination cursor returned from a previous request.

filterstring
Example:name eq "My Automation Connection" and connectorId eq "0d87347d-27c0-11ea-921c-022e6b5ea1e2" and ownerId eq "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy" and spaceId eq "5f0f78b239ff4f0001234567"

Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId.

limitinteger
Example:50

The number of automation connections to retrieve.

listAllboolean

When true, list all connections. Restricted to tenant admins and analytics admins.

sort'id' | 'name' | 'createdAt' | 'updatedAt' | '+id' | '+name' | '+createdAt' | '+updatedAt' | '-id' | '-name' | '-createdAt' | '-updatedAt'
Example:-name

The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order).

Response

OK Response

Example response

{
  "data": [
    {
      "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
      "name": "auto conn",
      "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
      "spaceId": "5f0f78b239ff4f0001234567",
      "createdAt": "2021-12-23T12:28:21.000000Z",
      "updatedAt": "2021-12-23T12:28:21.000000Z",
      "connectorId": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
      "isConnected": true
    }
  ]
}