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/listResearches
- 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 casos do workspace​

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

Lista os casos do workspace, do mais recentemente editado para o mais antigo, com total do filtro inteiro e a página em data.

Todos os filtros são opcionais e se combinam. kanbanId é a página de uma raia do quadro — é com ele que o front monta cada coluna. A raia Abertura traz também os casos antigos, que nasceram antes de o caso guardar a raia.

search procura pelo value de um envolvido: uma placa (que sempre tem letra) ou um CPF/CNPJ (que só tem dígito). Uma busca nunca acha a outra.

Cada item traz as contagens de filhos (vehicleCount, entityCount, documentCount), que saem da mesma fonte do detalhe — a lista e o card nunca divergem.

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"

Query Parameters

userId

Filtra pelos casos abertos por este usuário.

Type
string
Format
"uuid"
domain

Filtra pelo domínio do caso (por exemplo, auto).

Type
string
Example"auto"
objective

Filtra pelo objetivo do caso.

Type
string
Example"sinistro"
status

Filtra pelo status do caso.

Type
string
Valid values
"CREATED""PROCESSING""COMPLETED""FAILED"
Example"CREATED"
search

Placa ou CPF/CNPJ de um envolvido. Devolve os casos em que esse envolvido aparece.

Type
string
Example"TST1A23"
kanbanId

Devolve só os casos nesta raia do quadro. O total passa a ser o da raia.

Type
string
Format
"uuid"
limit

Tamanho da página. Ausente, zero ou negativo vale 10.

Type
integer
Example20
Default
10
offset

Quantos itens pular. Negativo vale zero; além do fim devolve uma página vazia, com o total intacto.

Type
integer
Example0
Default
0

Responses​

A página de casos e o total do filtro.

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"workspaceId": "string",
  
  
  
"userId": "string",
  
  
  
"domain": "auto",
  
  
  
"objective": "sinistro",
  
  
  
"reportAddress": "string",
  
  
  
"reportText": "string",
  
  
  
"doubts": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"status": "CREATED",
  
  
  
"incidentType": "colisao",
  
  
  
"bot": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"kanbanId": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string",
  
  
  
"reportTime": "2026-11-03 23:48",
  
  
  
"vehicleCount": 1,
  
  
  
"entityCount": 2,
  
  
  
"documentCount": 7
  
  
}
  
],
  
"total": 42
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI