Restofy Docs
Grupos de comensales POST

Listar grupos de comensales

POST /api/guest-groups/list-guest-groups

Descripción

Lista paginada de los grupos de comensales, como familia, pareja o ejecutivos.

Detalles

Devuelve los grupos del negocio, incluidos los del sistema y los pausados. Acepta búsqueda por texto y orden por posición o nombre.

Permisos requeridos

admin.module

Request

Nombre Tipo Requerido Reglas
search string No
max:100

Paginación

defaultLimit 50
maxLimit 100
allowedSorts sortOrder, name
defaultSort sortOrder
defaultDir asc
withTotal true

Ejemplo de request

curl -X POST https://restofy.pro/api/guest-groups/list-guest-groups \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>" \
  -H "X-Tenant-Key: <tenantKey>"

Los valores son demo: reemplázalos por datos reales del negocio.

Ejemplo de respuesta

Actualizado: 2026-09-08T16:35:34Z
HTTP 200

Request

[]

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "guestGroups": [
            {
                "guestGroupId": 1,
                "name": "Pareja",
                "iconFontAwesome": "fa-solid fa-heart",
                "sortOrder": 1,
                "isSystem": 1,
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "guestGroupId": 2,
                "name": "Familia",
                "iconFontAwesome": "fa-solid fa-people-roof",
                "sortOrder": 2,
                "isSystem": 1,
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "guestGroupId": 3,
                "name": "Amigos",
                "iconFontAwesome": "fa-solid fa-user-group",
                "sortOrder": 3,
                "isSystem": 1,
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "guestGroupId": 4,
                "name": "Compañeros",
                "iconFontAwesome": "fa-solid fa-briefcase",
                "sortOrder": 4,
                "isSystem": 1,
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "guestGroupId": 5,
                "name": "Individual",
                "iconFontAwesome": "fa-solid fa-user",
                "sortOrder": 5,
                "isSystem": 1,
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "guestGroupId": 6,
                "name": "Negocios",
                "iconFontAwesome": "fa-solid fa-handshake",
                "sortOrder": 6,
                "isSystem": 1,
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "guestGroupId": 7,
                "name": "Turista",
                "iconFontAwesome": "fa-solid fa-plane",
                "sortOrder": 7,
                "isSystem": 1,
                "isActive": 1,
                "isAvailable": 1
            },
            {
                "guestGroupId": 8,
                "name": "Evento",
                "iconFontAwesome": "fa-solid fa-champagne-glasses",
                "sortOrder": 8,
                "isSystem": 1,
                "isActive": 1,
                "isAvailable": 1
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 50,
            "total": 8,
            "totalPages": 1,
            "hasNext": false,
            "hasPrev": false
        }
    }
}