VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Central de pendências

Consultar pendências

Lista as pendências com filtros e devolve o resumo por tipo e por responsável.

As pendências são geradas sozinhas pela plataforma quando algo precisa de uma pessoa: um produto à espera de moderação, um cadastro aguardando aprovação, um pedido que exige aprovação, uma devolução solicitada. Estas duas rotas leem a fila. Exigem o privilégio view_tasks ou manage_tasks.

Listar pendências

GET/api/v1/admin/tasksAdmin

Lista as pendências

Parâmetros de consulta

statusstring
openin_progresssnoozeddonecancelled
Filtra por estado. open inclui também as adiadas cujo prazo de adiamento já passou.
typestring
product_moderationreturn_requestreview_moderationpending_userkyc_revieworder_approvalchargebackrfq
Filtra por tipo.
assigned_touuid
Filtra pelo responsável.
overdueboolean
true devolve só as atrasadas: prazo vencido e estado open ou in_progress. Qualquer outro valor é ignorado.
pageintegerpadrão: 1
Página, a partir de 1.
per_pageintegerpadrão: 50
Itens por página, de 1 a 200. Fora disso volta para 50.

Exemplo de requisição

Resposta

200Pendências

Campos da resposta

itemsarray
As pendências da página, da que vence primeiro para a que vence por último.
items[].iduuid
Id da pendência.
items[].typestring
product_moderationreturn_requestreview_moderationpending_userkyc_revieworder_approvalchargebackrfq
Tipo de pendência.
items[].entity_type / entity_idstring
O registro que gerou a pendência (por exemplo user e o UUID do cadastro).
items[].titlestring
Código estável (igual ao tipo), não é um texto para exibir: monte o título na sua interface a partir de type e metadata.
items[].linkstring
Caminho no painel onde a pendência é resolvida.
items[].statusstring
openin_progresssnoozeddonecancelled
Estado atual. Veja a tabela na home da seção.
items[].assigned_touuid
Responsável. null se ninguém pegou.
items[].assigned_to_namestring
Nome (ou e-mail) do responsável. Vazio sem responsável.
items[].due_atstring
Prazo (RFC 3339), criado + SLA.
items[].snoozed_untilstring
Até quando está adiada. null se não está.
items[].metadataobject
Dados do registro de origem para montar o título (por exemplo email, razao_social). O conteúdo varia por tipo.
items[].created_at / updated_atstring
Datas (RFC 3339, UTC).
totalinteger
Total de pendências que casam com o filtro, em todas as páginas.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["view_tasks","manage_tasks"]}
500Falha ao consultar.{"error":"failed","detail":"..."}
Pendência adiada que voltou

Uma pendência adiada cujo prazo passou aparece no filtro status=open, mas o campo status dela continua snoozed até alguém mexer. Se você montar sua própria fila, trate snoozed com snoozed_until no passado como aberta.

Resumo

GET/api/v1/admin/tasks/summaryAdmin

Contagens por tipo e por responsável

Exemplo de requisição

Resposta

200Resumo

Campos da resposta

by_typearray
Por tipo com pendências: type, open e overdue.
by_assigneearray
Por responsável: user_id, name, open e overdue. Pendências sem responsável não entram aqui.
open_totalinteger
Total em aberto: estados open, in_progress e snoozed.
overdueinteger
Total atrasado: prazo vencido, nos estados open e in_progress.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["view_tasks","manage_tasks"]}
500Falha ao consultar.{"error":"failed","detail":"..."}
Para um selo no menu

open_total e overdue bastam para mostrar um contador de pendências no seu painel.

Veja também

  • Agir nas pendências
  • Paginação
Anterior
Central de pendências
Próxima
Agir nas pendências
Nesta página
  • Listar pendências
  • Exemplo de requisição
  • Resposta
  • Erros
  • Resumo
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl "$BASE_URL/api/v1/admin/tasks?status=open&type=order_approval&per_page=50" \
  -H "Authorization: Bearer $TOKEN"
bash
curl "$BASE_URL/api/v1/admin/tasks/summary" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "items": [
    {
      "id": "6012aec0-1d2a-421a-ba12-4f040d41b5e5",
      "type": "pending_user",
      "entity_type": "user",
      "entity_id": "264a70c1-9c69-458d-ac73-838543f87da2",
      "title": "pending_user",
      "link": "/admin/users/264a70c1-9c69-458d-ac73-838543f87da2",
      "status": "open",
      "assigned_to": null,
      "assigned_to_name": "",
      "due_at": "2026-10-13T20:50:22.448751Z",
      "snoozed_until": null,
      "metadata": {
        "cnpj": "12.345.678/0001-95",
        "email": "compras@example.com",
        "razao_social": "Comercial Exemplo Ltda"
      },
      "created_at": "2026-10-11T20:50:22.449253Z",
      "updated_at": "2026-10-11T20:50:22.449253Z"
    }
  ],
  "total": 1
}
json
{
  "by_type": [
    {
      "type": "order_approval",
      "open": 4,
      "overdue": 1
    },
    {
      "type": "pending_user",
      "open": 2,
      "overdue": 0
    }
  ],
  "by_assignee": [
    {
      "user_id": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc",
      "name": "Maria Souza",
      "open": 3,
      "overdue": 1
    }
  ],
  "open_total": 6,
  "overdue": 1
}