Upnify Documentación API
CRM · /catalogos/grupos

Catálogos

Lista

GET/catalogos/grupos

Lista el catálogo de grupos de usuarios del sistema.

Parámetros

NombreTipoValidaciónDescripción
tkGrupovarcharDato utilizado por la operación del endpoint.
idUsuarioGrupointDato utilizado por la operación del endpoint.
nivelintDato utilizado por la operación del endpoint.
paginaintNúmero de página que se consulta.
cantidadRegistrosintCantidad máxima de registros que se devuelve por página.

Respuesta

NombreTipoDescripción
indiceIntegerDefine la posición de un registro, con respecto a los demás registros.
grupoStringAlmacena el nombre del grupo de usuarios.
auditadoBooleanDefine que las ventas realizadas por los usuarios pertenecientes al grupo necesitan ser auditadas.
tkGrupoUUIDEl código token que corresponde al grupo de usuario.
nivelIntegerEl nivel del grupo a listar.
subGruposStringUn arreglo de objetos que contienen el tkGrupo y el nombre de los subgrupos del grupo listado.

Solicitud

Ejemplo de solicitud

curl --request GET \
  --url 'https://api.upnify.com/v4/catalogos/grupos?tkGrupo=00000000-0000-4000-8000-000000000010&idUsuarioGrupo=1&nivel=1&pagina=1&cantidadRegistros=50' \
  --header 'token: 00000000-0000-4000-8000-000000000001'

Respuesta

Respuesta exitosa

JSON
[
  {
    "indice": 0,
    "grupo": "valor-grupo",
    "auditado": "valor-auditado",
    "tkGrupo": "00000000-0000-4000-8000-000000000010",
    "nivel": 0,
    "subGrupos": "valor-subGrupos"
  }
]