ConnectCloud Developers

List the automations of the tenant or of a space (desk access; a space the caller sees)

GET /api/desk/v1/automations

Module: Desk · operationId: listDeskAutomations · Tag: Automation · Auth: access token (Authorization: Bearer <accessToken>)

Scope tenant: everyone with desk access. Scope space:<id>: whoever sees the space (a space the caller does not see, or an unknown one, is 404; a malformed scope 400 scope). In position order, each with its newest execution (lastRun).

Parameters

Name In Type Required Description
scope query string yes Whose automations: tenant (every space) or space:<space id>

Responses

  • 200 The automations (application/json)
  • 400 Error (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • items (array of Automation, required)
    • blocking (boolean, required): true: a failure of the automation refuses the change that triggered it (422 automation_blocked); false (default): the failure is logged and the change is kept
    • createdAt (string (date-time), required): When the automation was created
    • createdBy (string, required): E-mail of who created it
    • description (string, required): The description of the definition
    • enabled (boolean, required): Only an enabled automation with a valid definition runs
    • events (array of string, required): The event types its triggers listen to
    • id (string (uuid), required): Id of the automation
    • key (string, required): The key of the definition, unique per scope
    • manual (boolean, required): Whether the definition has a manual trigger
    • name (string, required): The name of the definition (the actor name of the automation's changes)
    • position (integer, required): Automations that listen to the same event run in position order
    • scope (string, required): What the automation belongs to: tenant or space:<space id>
    • updatedAt (string (date-time), required): When the automation was last changed
    • updatedBy (string, required): E-mail of who changed it last
    • valid (boolean, required): The definition had no error when it was saved; a draft with errors (false) cannot be enabled
    • version (integer, required): Name it when changing or deleting the automation
    • yaml (string, required): The definition (YAML of the flow language)
    • lastRun (AutomationRun): One execution of an automation in its log.
      • automationId (string (uuid), required): Automation that ran
      • createdAt (string (date-time), required): When the run happened
      • depth (integer, required): 1 when a person's (or another service's) change started it, n when automations started each other
      • durationMs (integer, required): Duration of the run in milliseconds
      • id (string (uuid), required): Id of the run
      • outcome (string, required): skipped: a limit stopped it (too many automations for one event) (one of succeeded, failed, skipped)
      • steps (integer, required): The number of nodes that ran
      • triggerKind (string, required): event: started by an event; manual: started by a person on a ticket (one of event, manual)
      • version (integer, required): The version of the automation that ran
      • actorKind (string): Who made the triggering change (person, integration, assistant, automation, system, scm)
      • errorCode (string): Failed runs: the stable code, e.g. transition_not_allowed, invalid, out_of_scope, expression, invalid_definition, action_failed
      • errorMessage (string): Why the run failed (only on failure)
      • event (string): The event type that started it
      • node (string): The id of the node that failed
      • startedBy (string): The person or actor behind the triggering change
      • subject (string): What the event was about: the item's id
  • total (integer)

Example 200 answer:

{
  "items": [
    {
      "blocking": false,
      "createdAt": "2026-10-05T09:00:00Z",
      "createdBy": "elias.gruber@muster-it.example",
      "description": "Eine kritische Störung bekommt sofort das Team Service Desk als mitarbeitendes Team.",
      "enabled": true,
      "events": [
        "desk.item.created"
      ],
      "id": "8c5d6e7f-9a0b-4c1d-8e3f-5a6b7c8d9e01",
      "key": "kritische-stoerung-1st-level",
      "manual": false,
      "name": "Kritische Störung an den Service Desk",
      "position": 1,
      "scope": "tenant",
      "updatedAt": "2026-10-05T09:00:00Z",
      "updatedBy": "elias.gruber@muster-it.example",
      "valid": true,
      "version": 1,
      "yaml": "schemaVersion: 1\nkey: kritische-stoerung-1st-level\nname: Kritische Störung an den Service Desk\ntriggers:\n  - { id: neu, kind: event, event: desk.item.created, filter: 'trigger.data.typeKey == \"stoerung\" \u0026\u0026 trigger.data.priority == \"kritisch\"' }\nnodes:\n  zuweisen:\n    kind: action\n    action: desk.item.assign\n    params: { ref: \"{{ trigger.data.itemId }}\", team: first-level, teamRole: collaborating }\nedges:\n  - neu -\u003e zuweisen\n"
    }
  ],
  "total": 1
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/desk/v1/automations?scope=tenant' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI