Automations

List your automation rules

List the company’s automation rules with cursor-based pagination, ordered by id ascending.

  • Filter by status, trigger_type, creation window (created[gte], created[lte]) and search by name with search.
  • A cursor issued for another company yields an empty page.
get/companies/{company}/automations/rules

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/automations/rules
  • 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).

Query parameters

limitinteger

Number of objects to return, between 1 and 100 (default 25).

starting_afterstring uuid

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

ending_beforestring uuid

Cursor for backward pagination: pass the id of the first object on the current page.

status'draft' | 'active' | 'paused'

Lifecycle status of the automation rule. A rule only fires while it is active. Exact match on status.

trigger_typestring

Trigger of the rule in resource.action form (e.g. invoice.paid), as listed by GET /v1/companies/{company}/automations/catalog. Exact match on trigger_type.

scope'empresa' | 'cartera'

Scope of the rule: empresa watches only your own company, cartera watches the other tax IDs your account operates. Exact match on scope.

created[gte]string date-time

Creation date (ISO 8601). Greater than or equal to the given value.

created[lte]string date-time

Creation date (ISO 8601). Less than or equal to the given value.

created[gt]string date-time

Creation date (ISO 8601). Strictly greater than the given value.

created[lt]string date-time

Creation date (ISO 8601). Strictly less than the given value.

searchstring

Free-text search. Escaped LIKE %term% (case-insensitive, max 80 chars) across the resource's key text columns, combined with the other filters (AND) and compatible with the cursor.

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

has_moreboolean required

Whether more pages are available after this one.

next_cursorstring nullable required

Opaque cursor for the next page, or null when has_more is false. The example below shows the shape used by most listings; others return a different one, so pass the value back verbatim instead of validating it.

Example response

{
  "data": [
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a61",
      "name": "Avisar de un cobro grande",
      "description": "Notifica a los administradores cuando se cobra una factura de 1000 EUR o más.",
      "trigger_type": "invoice.paid",
      "scope": "empresa",
      "conditions": {
        "field": "total",
        "operator": "gte",
        "value": 1000
      },
      "actions": [
        {
          "type": "notify_in_app",
          "order": 0,
          "parameters": {
            "recipient_type": "role",
            "role": "admin",
            "category": "invoice",
            "title": "Cobro grande",
            "message": "Se ha cobrado una factura de 1000 EUR o más."
          }
        }
      ],
      "status": "active",
      "current_version": 2,
      "created_at": "2026-03-15T10:00:00Z",
      "updated_at": "2026-03-16T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

Changes

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