AutomationsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/elocuenti-com/json-schema/elocuenti-com-automations-response-schema.json",
  "title": "AutomationsResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elocuenti-com-automations-api-openapi.yml#/components/schemas/AutomationsResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Automation"
      },
      "title": "Data"
    },
    "request_id": {
      "type": "string",
      "description": "The identifier of this request. Give it to support if you need help.",
      "title": "Request Id"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Send it as `cursor` to get the next page. `null` on the last page.",
      "title": "Next Cursor"
    },
    "has_more": {
      "type": "boolean",
      "description": "`true` when there is another page.",
      "title": "Has More"
    }
  },
  "required": [
    "data",
    "request_id",
    "next_cursor",
    "has_more"
  ],
  "$defs": {
    "Automation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier of the automation. Use it in the path of the operations that start and read runs.",
          "title": "Id"
        },
        "name": {
          "type": "string",
          "description": "The name of the automation, as your team sees it in the dashboard.",
          "title": "Name"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "paused"
          ],
          "description": "`active` when the automation can be started. A `paused` one is listed so its identifier stays stable, but starting it is refused until your team turns it on.",
          "title": "Status"
        },
        "variables": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AutomationVariable"
          },
          "description": "The values the automation expects (at most 20). Empty when it expects none.",
          "title": "Variables"
        }
      },
      "required": [
        "id",
        "name",
        "status",
        "variables"
      ],
      "description": "An automation an integrator can start.",
      "title": "Automation"
    },
    "AutomationVariable": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the variable: lowercase letters, digits and `_`, from a letter. The steps of the automation read it as `{{trigger.variables.<name>}}`.",
          "title": "Name"
        },
        "required": {
          "type": "boolean",
          "description": "`true` when every run must send this variable.",
          "title": "Required"
        },
        "label": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "What the variable is, as the person who built the automation described it, or `null`.",
          "title": "Label"
        }
      },
      "required": [
        "name",
        "required",
        "label"
      ],
      "description": "A value the automation expects in every run.",
      "title": "AutomationVariable"
    }
  }
}