Erros e paginação

Formato de erro

Erros retornam ok: false e um objeto error com um code estável (use-o na sua lógica), uma message legível e details opcional.

{
  "ok": false,
  "error": {
    "code": "validation_error",
    "message": "O campo name é obrigatório.",
    "details": { "field": "name" }
  }
}

Códigos comuns

• 400 validation_error — o corpo enviado é inválido.
• 401 missing_api_key / invalid_api_key — problema de autenticação.
• 403 insufficient_scope — a chave não tem o escopo necessário.
• 404 not_found — o recurso não existe na sua conta.
• 503 api_not_configured — a API pública não está habilitada.

Paginação

Os endpoints de listagem (/contacts, /deals) aceitam limit e offset na query string. O limit padrão é 25 e o máximo é 100.

curl "https://app.pipecor.com/api/v1/contacts?limit=50&offset=100" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

A resposta traz os itens em data e os metadados de paginação em meta.

{
  "ok": true,
  "data": [ /* itens */ ],
  "meta": {
    "limit": 50,
    "offset": 100,
    "count": 50
  }
}