<!-- https://www.akrus.digital/docs/api/produtos · revisado em 2026-10-08 · gerado do mesmo conteúdo da página HTML -->
_Referência da API · v1 em prévia_

# Consulte produtos.

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

> **Antes de integrar**
>
> Contrato em prévia. A implementação foi validada localmente; a liberação em produção ainda precisa ser confirmada pela equipe. O acesso programático exige plano Scale efetivo, credencial e escopos autorizados. Solicite acesso e a URL do ambiente antes de integrar.
>
> [Ver disponibilidade](https://www.akrus.digital/docs/ambientes)

## `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.

Escopos: `products:read`

| Nome | Descrição |
| --- | --- |
| limit | De 1 a 100; padrão 50. |
| cursor | Cursor opaco da página anterior. Omita na primeira consulta. |

**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.

| Campo | Significado e tratamento |
| --- | --- |
| id | Identificador do produto. Trate como string. |
| slug | Identificador legível do produto. |
| name | Nome cadastrado do produto. |
| type | Tipo cadastrado. Trate como texto e tolere novos valores. |
| status | Estado do produto: rascunho, publicado ou arquivado no contrato atual. |
| created_at | Data e hora de criação; usada na ordenação. |
| updated_at | Data e hora da última atualização. Não é o campo de paginação. |
| published_at | Data e hora de publicação, quando preenchida; pode ser null. |

> **O que não está no catálogo público**
>
> A resposta não inclui aulas, arquivos, preços de ofertas ou o rascunho completo do editor. Não deduza um link de checkout ou a disponibilidade de uma oferta apenas pelo estado do produto. Se sua integração depende desses dados, apresente o requisito à equipe antes de escolher este recurso como fonte.

## Dúvidas frequentes

### Posso filtrar por estado, período ou outro produtor?

O contrato publicado aceita limit e cursor. Filtros por estado, período, busca ou seleção de outro produtor não fazem parte desta referência. O produtor é determinado pela credencial.

### Como tratar campos vazios ou novos?

Preserve null como ausência de valor. Não transforme uma data ausente em uma data atual ou um valor financeiro ausente em zero. Tolere campos adicionais e valores de estado que sua aplicação ainda não conheça.

## Percorra a coleção completa

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

[Implementar paginação](https://www.akrus.digital/docs/paginacao)

---

Anterior: [Referência da API](https://www.akrus.digital/docs/api) · Próximo: [API de vendas](https://www.akrus.digital/docs/api/vendas)
