Listar
Obtén el listado paginado de las automatizaciones de tu organización.
Descripción general
Este endpoint devuelve en un solo listado las automatizaciones recurrentes, por calendario personalizado y por plan de proyecto de tu organización, de la más reciente a la más antigua según created_at. Cada resultado incluye el campo type, que indica el tipo de automatización y qué campos trae. El tamaño de página es fijo en 20 resultados.
Puedes filtrar por tipo, estatus y cliente. Los filtros se combinan entre sí y los query params desconocidos se ignoran.
Requiere el permiso Leer en Automatizaciones.
Endpoint
https://app.credonix.mx/api/v1/automationsConsulta las automatizaciones de un cliente
Devuelve las automatizaciones de todos los tipos que pertenecen al cliente, ordenadas de la más reciente a la más antigua. Usa page para recorrer las páginas; next y previous conservan los demás query params.
Query params
| Parámetro | Tipo | Requerido | Default | Descripción |
|---|---|---|---|---|
customer_id | string | No | - | ID del cliente. Acepta varios valores, repitiendo el parámetro o separados por comas. |
page | integer ≥ 1 | No | 1 | Página solicitada. El tamaño de página es fijo en 20. |
Filtra por tipo y estatus
type y status aceptan varios valores, repitiendo el parámetro (?type=recurring&type=project_plan) o separados por comas (?type=recurring,project_plan). Sin type, el listado incluye los tres tipos.
Query params
| Parámetro | Tipo | Requerido | Default | Descripción |
|---|---|---|---|---|
type | recurring, custom_schedule, project_plan | No | - | Tipo de automatización. |
status | active, paused, completed | No | - | Estatus de la automatización. |
Forma de las respuestas
Todos los tipos comparten estos campos:
| Campo | Tipo | Descripción |
|---|---|---|
type | string | recurring, custom_schedule o project_plan. |
id | string | ID de la automatización. |
customer_id | string | Cliente al que se cobra. |
legal_entity_id | string | null | Razón social que emite las órdenes de cobro. |
concept | string | Concepto de las órdenes de cobro. |
description | string | null | Descripción. |
currency | string | MXN o USD. |
status | string | active, paused o completed. |
grace_period_days | integer | Días entre la emisión y el vencimiento de cada orden de cobro. |
subtotal, total_discount, total_tax, total_amount | string | null | Totales de la automatización. |
next_billing_date | string | null | Próxima fecha de cobro (YYYY-MM-DD). null si la automatización no está active. |
created_at, updated_at | string (fecha) | Marcas de tiempo. |
Además, cada tipo agrega sus propios campos:
recurring:start_date,end_date,interval,repeat_every,monthly_mode,weekdays,last_execution_ateitems. Ver Consultar automatización recurrente.custom_schedule:entries, una por fecha de cobro, cada una con sus totales,processedeitems. Ver Consultar calendario personalizado.project_plan:billing_mode,auto_even_split,remaining_amount,last_execution_at,itemsymilestones. Ver Consultar plan de proyecto.
Errores
| Status | Código | Causa |
|---|---|---|
400 | INVALID_PAGE | page no es un número entero entre 1 y 107374183. |
400 | INVALID_QUERY_PARAMETER | type o status traen un valor que no está en la lista. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Automatizaciones. |
{
"code": "INVALID_QUERY_PARAMETER",
"message": "El parámetro type debe ser uno de: recurring, custom_schedule, project_plan.",
"errors": [
{
"field": "type",
"code": "invalid_value",
"message": "El parámetro type debe ser uno de: recurring, custom_schedule, project_plan."
}
],
"request_id": "72c74242-d0c5-4c3c-9a20-fbcce31af58e"
}