Factuarea APIDevelopers

Listar ejecuciones de automatización

Recorre el historial de ejecuciones de automatización de la empresa autenticada con paginación por cursor, filtrando por status, por automation_rule_id o por ventana de creación.

  • Toma el scope propio automation_runs:read en lugar del que lee reglas, porque una ejecución lleva dentro el data.object congelado del evento que la disparó —importes, destinatarios, resultados de las acciones— y eso se concede aparte.
  • Las páginas se ordenan por id ascendente, así que el historial se lee de lo más antiguo a lo más reciente; recórrelo con ending_before para ir en sentido contrario.
GET
/automations/runs
AuthorizationBearer <token>

En: header

Parámetros de consulta

automation_rule_id?string

ID (UUID v7) de la regla de automatización cuyas ejecuciones se listan.

Formatouuid
subject_company_id?string

ID (UUID v7) de la empresa gestionada sobre la que actuó la ejecución. Solo las empresas que gestionas dan resultados.

Formatouuid
limit?integer

Número de objetos a devolver. Entero entre 1 y 100. Por defecto 25.

Predeterminado25
Rango1 <= value <= 100
starting_after?string

Cursor para paginación hacia delante. Usa el uuid del último objeto de la página anterior.

Formatouuid
ending_before?string

Cursor para paginación hacia atrás. Usa el uuid del primer objeto de la página actual.

Formatouuid
status?string

Estado de la ejecución. dead_lettered y failed son los que vale la pena relanzar; blocked significa que un límite del motor la detuvo antes de ejecutar. Coincidencia exacta con status.

Valor en"pending" | "running" | "completed" | "failed" | "dead_lettered" | "blocked"
created[gte]?string

Fecha de creación (ISO 8601). Mayor o igual que el valor dado.

Formatodate-time
created[lte]?string

Fecha de creación (ISO 8601). Menor o igual que el valor dado.

Formatodate-time
created[gt]?string

Fecha de creación (ISO 8601). Estrictamente mayor que el valor dado.

Formatodate-time
created[lt]?string

Fecha de creación (ISO 8601). Estrictamente menor que el valor dado.

Formatodate-time

Headers

Factuarea-Version?string

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate
X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json