📚Grupos

📚 Listar grupos

Endpoint

GET https://sua-plataforma.ensinio.cloud/public/api/v1/groups

Headers obrigatórios

  • Authorization: Bearer {token}
  • X-Requested-With: XMLHttpRequest

(Os mesmos do “Getting Started”.)

Descrição

Retorna a lista de grupos (cursos/conteúdos agregados) com paginação.

Este endpoint depende da feature estar habilitada no seu plano.

Parâmetros de query

ParâmetroTipoObrigatórioPadrãoDescrição
pageinteger1Número da página.
per_pageinteger15Quantidade de itens por página (≥ 1).

Exemplos de requisição

Listar grupos (padrão)

GET /public/api/v1/groups?page=1&per_page=15

Paginar com 50 itens por página

GET /public/api/v1/groups?page=2&per_page=50

Exemplo de resposta (paginação padrão do Laravel)

{
  "data": [
    {
      "id": "1",
      "title": "Curso Completo de Marketing",
      "slug": "curso-completo-de-marketing",
      "description": "Aprenda do zero à prática: branding, mídia paga e funil."
    },
    {
      "id": "2",
      "title": "E-book Vendas",
      "slug": "e-book-vendas",
      "description": "Guia prático com técnicas e scripts de fechamento."
    }
  ],
  "links": {
    "first": "https://sua-plataforma.ensinio.cloud/public/api/v1/groups?page=1",
    "last": "https://sua-plataforma.ensinio.cloud/public/api/v1/groups?page=10",
    "prev": null,
    "next": "https://sua-plataforma.ensinio.cloud/public/api/v1/groups?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "https://sua-plataforma.ensinio.cloud/public/api/v1/groups",
    "per_page": 15,
    "to": 15,
    "total": 150
  }
}

🧩 Estrutura de cada item (GroupIndexResource)

CampoTipoDescrição
idintIdentificador único do grupo.
titlestringTítulo do grupo.
slugstringSlug amigável do grupo.
descriptionstringDescrição breve do grupo.

Possíveis respostas

  • 200 OK — Retorna a lista paginada conforme o exemplo.
  • 400 Bad Request — Validação falhou (ex.: per_page inválido).
  • 401 Unauthorized — Token inválido ou ausente.
  • 403 Forbidden — Recurso não habilitado no plano (feature desativada).
  • 429 Too Many Requests — Limite de requisições excedido.
  • 500 Internal Server Error — Erro inesperado ao listar os grupos.