API de Grupos

Lista os grupos de clientes disponíveis para o cliente de API. Um cliente da organização vê os grupos da sua organização; um cliente de grupo vê apenas seu próprio grupo.

Listar grupos

GET /api/v1/groups

Escopo obrigatório: training.read. Consulte Autenticação para obter um token de acesso.

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	Padrão	Descrição
page	inteiro	1	Número da página, a partir de 1.
pageSize	inteiro	1000	Grupos por página, de 1 a 5000.
includeArchived	booleano	false	Use true para incluir grupos arquivados.

Resposta

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

Campo	Tipo	Descrição
groupId	UUID	Identificador do grupo. Corresponde ao groupId dos registros de treinamento e dos certificados.
name	string	Nome do grupo.
supplierNo	string ou null	Número de fornecedor atribuído ao grupo, quando disponível.
archived	booleano	Indica se o grupo está arquivado.

Os grupos são ordenados por nome e depois por groupId. O objeto pagination conta os grupos após aplicar includeArchived. Quando não há resultados, data está vazio e totalPages é 0.

Para consultar um groupId de dados de treinamento antigos, use includeArchived=true se o grupo puder estar arquivado.

Erros

Paginação inválida retorna 400 no formato Problem Details. Token ausente ou expirado retorna 401; escopo insuficiente ou perda de acesso do cliente retorna 403. O limite compartilhado pode retornar 429. Consulte Autenticação para conhecer os limites e as orientações de nova tentativa.

OpenAPI

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