API de grupos

Lista los grupos de clientes disponibles para el cliente de API. Un cliente de organización ve los grupos de su organización; un cliente de grupo solo ve su propio grupo.

Listar grupos

GET /api/v1/groups

Ámbito requerido: training.read. Consulta Autenticación para obtener un token de acceso.

curl --request GET \
  --url "https://courses.e-learningcourses.com/api/v1/groups?page=1&pageSize=1000&includeArchived=false" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "Accept: application/json"

Parámetros de consulta

Parámetro	Tipo	Predeterminado	Descripción
page	entero	1	Número de página, a partir de 1.
pageSize	entero	1000	Grupos por página, entre 1 y 5000.
includeArchived	booleano	false	Usa true para incluir grupos archivados.

Respuesta

{
  "data": [
    {
      "groupId": "fbc74870-3995-4f2c-b129-c2812b3e56c7",
      "name": "Proveedor de ejemplo",
      "supplierNo": "SUP-1042",
      "archived": false
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1000,
    "totalRecords": 1,
    "totalPages": 1
  }
}

Campo	Tipo	Descripción
groupId	UUID	Identificador del grupo. Coincide con groupId en los registros de formación y los certificados.
name	cadena	Nombre del grupo.
supplierNo	cadena o null	Número de proveedor asignado al grupo, cuando existe.
archived	booleano	Indica si el grupo está archivado.

Los grupos se ordenan por nombre y luego por groupId. El objeto pagination cuenta los grupos después de aplicar includeArchived. Si no hay resultados, data está vacío y totalPages vale 0.

Para consultar un groupId de datos de formación antiguos, usa includeArchived=true si el grupo puede estar archivado.

Errores

Una paginación no válida devuelve 400 en formato Problem Details. Si falta el token o ha caducado, se devuelve 401; si falta el ámbito o el cliente ha perdido el acceso, se devuelve 403. El límite compartido puede devolver 429. Consulta Autenticación para conocer los límites y cómo reintentar.

OpenAPI

https://courses.e-learningcourses.com/api/v1/openapi.json