Skip to main content
GET
/
api
/
v1
/
automation
curl -X GET "https://your-collabase.ch/api/v1/automation" \
  -H "Authorization: Bearer cba_live_xYz123ABCD..."

[
  {
    "id": "auto-abc123",
    "name": "Notify on test failure",
    "description": "Sends a notification when a critical test case fails",
    "isEnabled": true,
    "triggerType": "COLLABASE_EVENT",
    "category": "test-management",
    "spaceId": "4d71eb4d-3638-4173-8698-d883a6c2243f",
    "createdAt": "2025-03-15T10:00:00.000Z"
  }
]
Returns all automation rules your API key has access to, ordered by creation date (newest first). Pass an optional spaceId query parameter to filter results to a specific space.
Results include automations you created as well as global automations available to your instance.

​
Query parameters

​
spaceId
string
Filter results to automations belonging to a specific space. Omit to return all automations visible to you.

​
Response

Returns an array of automation objects.
​
id
string
required
Unique identifier of the automation.
​
name
string
required
Display name of the automation.
​
description
string
Optional description of what the automation does.
​
isEnabled
boolean
required
Whether the automation is currently active. Disabled automations cannot be triggered.
​
triggerType
string
required
How the automation is initiated. One of: COLLABASE_EVENT, WEBHOOK, SCHEDULE, MANUAL.
​
category
string
Category grouping for the automation (e.g., test-management).
​
spaceId
string
UUID of the space this automation belongs to. null for global automations.
​
createdAt
string
required
ISO 8601 timestamp of when the automation was created.
curl -X GET "https://your-collabase.ch/api/v1/automation" \
  -H "Authorization: Bearer cba_live_xYz123ABCD..."

[
  {
    "id": "auto-abc123",
    "name": "Notify on test failure",
    "description": "Sends a notification when a critical test case fails",
    "isEnabled": true,
    "triggerType": "COLLABASE_EVENT",
    "category": "test-management",
    "spaceId": "4d71eb4d-3638-4173-8698-d883a6c2243f",
    "createdAt": "2025-03-15T10:00:00.000Z"
  }
]