Automations

Retrieve the automation catalog

Return what you need to build a valid automation rule: visible triggers, condition operators and combinators, and actions with their parameter JSON schema.

  • Visibility follows the company’s plan and modules; labels follow Accept-Language (default Spanish).
  • Trigger fields are served per trigger by GET /v1/companies/{company}/automations/catalog/triggers/{trigger}/fields.
get/companies/{company}/automations/catalog

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/automations/catalog
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "triggers": [
      {
        "key": "invoice.paid",
        "label": "Factura pagada",
        "category": "invoice",
        "module": "invoices"
      }
    ],
    "operators": [
      {
        "key": "gte",
        "label": "Es mayor o igual que",
        "applies_to": [
          "integer",
          "number",
          "datetime"
        ],
        "value_shape": "scalar"
      }
    ],
    "combinators": [
      {
        "key": "and",
        "label": "Se cumplen todas las condiciones"
      }
    ],
    "actions": [
      {
        "key": "notify_in_app",
        "label": "Notificación en la aplicación",
        "parameters": [
          {
            "name": "recipient_type",
            "type": "enum",
            "required": true,
            "allowed_values": [
              "role",
              "user"
            ],
            "label": "Tipo de destinatario",
            "description": "Decide si la notificación va a un rol de la empresa o a un usuario concreto."
          }
        ],
        "supports_portfolio_scope": true,
        "module": null
      },
      {
        "key": "create_task",
        "label": "Crear una tarea",
        "parameters": [
          {
            "name": "project_id",
            "type": "uuid",
            "required": true,
            "allowed_values": [],
            "label": "Proyecto",
            "description": "Proyecto de tu empresa en el que se crea la tarea. Debe estar activo cuando la automatización se ejecute."
          }
        ],
        "supports_portfolio_scope": true,
        "module": "tasks"
      }
    ],
    "scopes": [
      {
        "key": "empresa",
        "label": "Tu empresa",
        "available": true,
        "unavailable_reason": null
      },
      {
        "key": "cartera",
        "label": "Tu cartera de empresas",
        "available": false,
        "unavailable_reason": "module_not_granted"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.