Ir para o conteúdo

Referência da API · v1 em prévia

Consulte acessos.

Lista concessões de acesso. Uma concessão pode ser reutilizada após uma recompra: esta coleção não representa um histórico de matrículas. A relação com a venda é feita por sale_id, sem identificar a pessoa.

GET/api/v1/access

Requer plano Scale efetivo. Escopo necessário: access:read. O produtor é definido pela credencial, enviada em Authorization: Bearer <sua-credencial>. Ordem decrescente por granted_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
  • access: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-000000000301",
      "product_slug": "curso-exemplo",
      "sale_id": "00000000-0000-4000-8000-000000000201",
      "status": "active",
      "origin": "purchase",
      "granted_at": "2026-09-03T12:01:00.000001Z",
      "revoked_at": null
    }
  ],
  "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 da concessão de acesso.
product_slugProduto ao qual a concessão se refere.
sale_idVenda relacionada, quando existe; pode ser null.
statusEstado da concessão: active, revoked ou refunded no contrato atual.
originOrigem da concessão. Trate como texto; não presuma que toda concessão veio de uma compra.
granted_atData e hora da concessão; usada na ordenação.
revoked_atData e hora de revogação, quando registrada; 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.