Developers

Aparência

Vai integrar a API REST da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/lens/listKanbanLanes
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher a API certa e fazer a primeira chamada autenticada]

Listar as raias do quadro​

GET
/api/v1/lens/{workspaceId}/kanban

As raias do quadro do workspace, num array na ordem do quadro: primeiro a fase (COLETA, ANALISE, DESFECHO), depois o order dentro da fase e, no empate, a criação. Não há paginação — o quadro tem poucas raias.

O quadro nasce na primeira leitura. Um workspace que nunca leu o quadro recebe as nove raias padrão gravadas nesta chamada, com o autor system:

Fase Raias
COLETA Abertura · Dados pendentes · Dados inconsistentes · Pronto para análise
ANALISE Analisando · Análise falhou · Analisado
DESFECHO Reprovado · Aprovado

Os ids das nove são estáveis: derivam do workspace, da fase e do nome, então são os mesmos em toda leitura. Duas chamadas simultâneas gravam cada raia uma única vez.

Use o id da raia no ?kanbanId= da listagem de casos para montar cada coluna, e no kanbanId do PUT do caso para mover um caso.

Raias INACTIVE continuam na lista: esconder é decisão do cliente.

Authorizations​

BearerAuth

Token Bearer JWT obtido em POST /api/v1/authentication. O workspace do token precisa ser o mesmo do caminho.

Type
HTTP (bearer)

Parameters​

Path Parameters

workspaceId*

O workspace dono do caso. Tem de ser o workspace do token.

Type
string
Required
Example"3f1a2b4c-5d6e-4f70-8a91-b2c3d4e5f607"
Format
"uuid"

Responses​

As raias do quadro, na ordem.

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"workspaceId": "string",
  
  
"userId": "system",
  
  
"phase": "COLETA",
  
  
"step": "Abertura",
  
  
"description": "",
  
  
"order": 1,
  
  
"status": "ACTIVE",
  
  
"createdAt": "string",
  
  
"updatedAt": "string"
  
}
]

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI