Referencia de la APIGrupos de mensajes
Listar
Consulta el listado paginado de los grupos de mensajes de cobranza de tu organización.
Descripción general
Este endpoint devuelve un listado paginado de los grupos de mensajes de cobranza de tu organización, del más reciente al más antiguo. Cada grupo incluye sus clientes y todos sus mensajes. El tamaño de página es fijo en 20 resultados.
Requiere el permiso Leer en Grupos de mensajes.
Endpoint
GET
https://app.credonix.mx/api/v1/message-groupsConsulta grupos de mensajes
Sin query params devuelve todos los grupos. Usa search para buscar por nombre y active para consultar solo los grupos activos o inactivos. Puedes combinar ambos filtros. Cada grupo tiene la misma forma que en Consultar grupo de mensajes.
Query params
| Parámetro | Tipo | Requerido | Default | Descripción |
|---|---|---|---|---|
page | integer ≥ 1 | No | 1 | Página solicitada. El tamaño de página es fijo en 20. |
search | string | No | - | Busca el texto en name, sin distinguir mayúsculas y minúsculas. |
active | true | false | No | - | Filtra por active. |
Errores
| Status | Código | Causa |
|---|---|---|
400 | INVALID_PAGE | page no es un número entero entre 1 y 107374183. |
400 | INVALID_QUERY_PARAMETER | active no es true ni false. |
401 | MISSING_API_KEY, INVALID_API_KEY, API_KEY_REVOKED | API key ausente, inválida o revocada. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Grupos de mensajes. |