GET/hyax-api/v1/automations/:id

Get automation

Returns automation with nodes and edges.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/automations/clx_example_id' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "name": "Welcome series",
    "description": "On signup",
    "status": "ACTIVE",
    "activeSubscriberCount": 12,
    "createdAt": "2025-01-15T12:00:00.000Z",
    "updatedAt": "2025-01-20T08:00:00.000Z",
    "nodes": [
      { "id": "node…", "type": "TRIGGER", "config": {}, "positionX": 0, "positionY": 0 }
    ],
    "edges": []
  }
}