Listagem de Conteúdos

Liste ou gere um arquivo com os conteúdos da sua instituição.

GET /api/content

Listagem de Conteúdos

cURL

curl --request GET \
  --url https://kong.api.toolzz.com.br/api/content

200

{
  "success": true,
  "contents": {
    "current_page": 123,
    "data": [
      {
        "id": 123,
        "title": "<string>",
        "description": "<string>",
        "contentType": "<string>",
        "contentUrl": "<string>",
        "isPublic": true,
        "createdAt": "<string>"
      }
    ],
    "first_page_url": "<string>",
    "from": 123,
    "last_page": 123,
    "last_page_url": "<string>",
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "next_page_url": "<string>",
    "path": "<string>",
    "per_page": 123,
    "prev_page_url": "<string>",
    "to": 123,
    "total": 123
  }
}

Parâmetros

type · string

Filtra os conteúdos pelo tipo. Aceita apenas os seguintes valores: text, audio, video, pdf, live.

course_id · int

Filtra os conteúdos de um curso específico com base no ID do curso.

does_sendemail · boolean

Caso deseje receber um arquivo com os conteúdos listados por e-mail, insira 1.

email_to_send · string

Endereço de e-mail para o qual o arquivo gerado será enviado.

public · boolean

Permite a busca por conteúdos avulsos no catálogo.

tags · string

Permite a busca por tags que fazem parte deste conteúdo.

per_page · int

Quantidade de registros que o endpoint retornará na paginação.

query · string

Filtra os dados por título e descrição. Para busca por IDs, use números separados por vírgula, por exemplo: 1,2.

contents_ids · string

Filtra por ID de conteúdos.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. A API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.

Descrição da Resposta

Abaixo está um exemplo da estrutura de resposta retornada por este endpoint.

success · boolean

Indica se a requisição foi concluída com sucesso.

contents · object

Objeto principal contendo a listagem paginada de conteúdos.

Show properties

current_page · number

Número da página atual retornada na paginação.

data · array

Lista dos conteúdos retornados nesta página.

Show items

id · number

Identificador único do conteúdo.

title · string

Título do conteúdo (ex: “Introdução ao Pensamento Criativo”).

description · string

Texto de descrição HTML do conteúdo, usado para apresentação inicial.

contentType · string

Tipo de conteúdo (ex: “text”, “video”, “quiz”).

contentUrl · string

URL para visualização completa do conteúdo.

isPublic · boolean

Define se o conteúdo é acessível publicamente (true) ou restrito (false).

createdAt · string

Data de criação do conteúdo no formato ISO 8601 (ex: “2024-08-12T10:42:31.000000Z”).

first_page_url · string

URL para a primeira página da listagem.

from · number

Índice do primeiro item exibido nesta página.

last_page · number

Número total de páginas disponíveis.

last_page_url · string

URL da última página da listagem.

links · array

Lista de objetos representando os links de navegação da paginação.

Show items

url · string

URL para a página indicada no label (pode ser null para links desativados).

label · string

Texto exibido no controle de navegação (ex: “1”, ”« Previous”).

active · boolean

Indica se o item representa a página ativa no momento.

next_page_url · string

URL da próxima página (ou null se for a última página).

path · string

Caminho base da API usado na paginação.

per_page · number

Quantidade de itens retornados por página.

prev_page_url · string

URL da página anterior (ou null se for a primeira).

to · number

Índice do último item da página atual.

total · number

Total de itens disponíveis na listagem.