API de Staff Pulse

Accede por API a las ventas, empleados, rankings, premios y reseñas de tu restaurante para integrarlos con tus propias herramientas, BI o automatizaciones. Todas las peticiones se autentican con la API key de tu cuenta.

Autenticación

Envía tu API key en la cabecera api_key de cada petición. Puedes solicitarla desde el panel de tu restaurante, en Integraciones.

curl "https://staff-pulse.base44.app/api/apps/{APP_ID}/entities/Employee" \
  -H "api_key: TU_API_KEY"

URL base

https://staff-pulse.base44.app/api

Endpoints de datos

GET/apps/{APP_ID}/entities/{Entity}

Listar registros

Devuelve los registros de la entidad. Admite paginación y ordenación con los parámetros limit, skip y sort.

GET https://staff-pulse.base44.app/api/apps/{APP_ID}/entities/SalesRecord?limit=100&sort=-date

GET/apps/{APP_ID}/entities/{Entity}/{id}

Obtener un registro

Devuelve un único registro por su identificador.

POST/apps/{APP_ID}/entities/{Entity}/filter

Filtrar registros

Filtra por cualquier campo de la entidad enviando un objeto JSON de condiciones.

{
  "tenant_id": "abc123",
  "date": { "$gte": "2026-09-01" }
}

Entidades disponibles

EmployeeEmpleados del restaurante, con puesto, turno y objetivo de ventas.

SalesRecordVentas agregadas por empleado y día.

ProductSalesMetricVentas por producto y empleado.

ReportSaleEventLíneas de venta detalladas (producto, categoría, método de pago, canal).

TabFactTickets/mesas con totales, impuestos, propinas y comensales.

ProductCategoryCategorías de producto sincronizadas del TPV.

ProductCatálogo de productos.

RankingPeriodPeriodos de ranking (diarios, semanales, mensuales o recurrentes).

AwardPremios configurados.

AwardAssignmentPremios entregados a empleados.

EmployeeReviewReseñas de clientes por empleado.

Buenas prácticas

Filtra siempre por tenant_id para acotar los datos a un restaurante concreto.
Usa limit y skip para paginar consultas grandes.
No expongas tu API key en aplicaciones de cliente: úsala solo desde tu servidor.

¿Necesitas ayuda con la integración?

Escríbenos y te ayudamos a conectar Staff Pulse con tus sistemas.