Ir al contenido

Referencia de API

Paginación, orden y filtros

Los endpoints que devuelven listas (contactos, oportunidades, conversaciones…) admiten parámetros de query para paginar, ordenar y filtrar.

ParámetroDescripción
pageNúmero de página (empieza en 1)
limitCantidad de elementos por página

Ejemplo:

Ventana de terminal
curl "https://api.waiify.com/workspaces/WORKSPACE_ID/contacts?page=2&limit=50" \
-H "Authorization: Bearer TU_API_KEY"

La respuesta trae los elementos de la página bajo data y los metadatos bajo pagination:

Forma de una respuesta paginada
{
"success": true,
"data": [ /* elementos de esta página */ ],
"pagination": { "page": 2, "limit": 50, "total": 134, "totalPages": 3 }
}

limit tiene un tope de 100 por página en todos los endpoints, aunque pidas más.

El nombre de los parámetros de orden varía por recurso (consulta la página del endpoint), pero el patrón es siempre sortBy / sortOrder. En contactos, por ejemplo:

ParámetroDescripción
sortByCampo por el que ordenar (name, createdAt, updatedAt…)
sortOrderasc o desc
ParámetroDescripción
searchBúsqueda de texto
statusFiltrar por estado (según el recurso)

Los filtros disponibles dependen de cada recurso; consulta la página del endpoint.