Listar roles

GET

https://api-pruebas.phoqo.cl/pruebas/v2/settings/roles

Lista los roles disponibles para la empresa (tenant) actual, paginados y con búsqueda.

Devuelve los roles globales (reference='0') más los roles específicos de la empresa (reference=tenant).

Filtro search (opcional): busca en name o description.

Ordenados por nombre. Incluye permissionCount (nº de permisos del rol) y requiredPermission.

Implementación MySQL (fallback antes de que OpenSearch esté poblado). El tenant se toma del header empresa.

Solicitud

Autorización

Agregar parámetro en header

Authorization

Ejemplo:

Authorization: ********************

Parámetros de consulta

Parámetros de Header

Respuestas

🟢200OK

application/json

Bodyapplication/json

Ejemplo de Solicitud

Shell

JavaScript

Java

Swift

curl --location 'https://api-pruebas.phoqo.cl/pruebas/v2/settings/roles?page=1&page_size=20&search=dentist' \
--header 'empresa: d6baef78-d4f0-457a-a119-7ebbbd4cdee8' \
--header 'empresa: ' \
--header 'grupo: 8561c7f0-111a-47d1-8efe-a50355778ab6' \
--header 'grupo: ' \
--header 'x-application: PHOQO' \
--header 'x-application: PHOQO' \
--header 'Authorization: <api-key>'

Ejemplo de Respuesta

{
    "roles": [
        {
            "rolId": "string",
            "name": "string",
            "description": "string",
            "permissionCount": 0,
            "requiredPermission": "string"
        }
    ],
    "total": 0,
    "page": 0,
    "pageSize": 0
}

Modificado en 2026-09-10 14:21:15

Remover un rol de un usuario

Asignar plan a empresa