Ir para o conteúdo

Referência da API · v1 em prévia

Consulte produtos.

Lista os produtos vinculados ao produtor da credencial. Não cria nem altera produtos.

GET/api/v1/products

Requer plano Scale efetivo. Escopo necessário: products:read. O produtor é definido pela credencial, enviada em Authorization: Bearer <sua-credencial>. Ordem decrescente por created_at, com desempate por id. A resposta abaixo usa dados sintéticos e ilustra o formato, sem representar uma operação real; a coleção também pode estar vazia.

Escopo
  • products:read

Parâmetros

NomeDescrição
limitDe 1 a 100; padrão 50.
cursorCursor opaco da página anterior. Omita na primeira consulta.

Exemplo de resposta

JSON
{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000101",
      "slug": "curso-exemplo",
      "name": "Curso de exemplo",
      "type": "curso",
      "status": "publicado",
      "created_at": "2026-09-01T12:00:00.000001Z",
      "updated_at": "2026-09-02T12:00:00.000001Z",
      "published_at": "2026-09-02T12:00:00.000001Z"
    }
  ],
  "next_cursor": null,
  "version": "v1"
}

Campos retornados

Campos sem valor são retornados como null. Campos adicionais devem ser tolerados pelo consumidor.

CampoSignificado e tratamento
idIdentificador do produto. Trate como string.
slugIdentificador legível do produto.
nameNome cadastrado do produto.
typeTipo cadastrado. Trate como texto e tolere novos valores.
statusEstado do produto: rascunho, publicado ou arquivado no contrato atual.
created_atData e hora de criação; usada na ordenação.
updated_atData e hora da última atualização. Não é o campo de paginação.
published_atData e hora de publicação, quando preenchida; pode ser null.

Dúvidas frequentes

Percorra a coleção completa

Use o cursor retornado para continuar e mantenha a conferência do estado atual dos registros.

Referência conferida em 8 de outubro de 2026. Relatar uma dúvida na documentação.