API Reference

API REST para integração com agentes de IA, automações (n8n) e aplicativos externos.

https://crm.grupozark.com.br/api/v1Ver como JSON (para agentes)

Autenticação

Todas as requisições precisam de uma API Key no header Authorization.

Authorization: Bearer zk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Gere sua chave em Configurações → API Keys no painel do Zark CRM.

📦 Espaços

GET/api/v1/spaces— Lista espaços acessíveis ao usuário

Exemplo

curl -H "Authorization: Bearer zk_SUA_KEY" \
  https://crm.grupozark.com.br/api/v1/spaces

Resposta

{
  "data": [
    {
      "id": "uuid",
      "name": "GERAIS",
      "color": "#ef4444",
      "status": "ativo",
      "created_at": "2026-01-15T10:00:00Z"
    }
  ]
}

GET/api/v1/spaces/{spaceId}/members— Lista membros de um espaço

Exemplo

curl -H "Authorization: Bearer zk_SUA_KEY" \
  https://crm.grupozark.com.br/api/v1/spaces/UUID/members

Resposta

{
  "data": [
    {
      "user_id": "uuid",
      "role": "admin",
      "full_name": "Nome Completo",
      "email": "email@exemplo.com"
    }
  ]
}

✅ Tarefas

GET/api/v1/spaces/{spaceId}/tasks— Lista tarefas com filtros

Param	Tipo	Descrição / Valores
status	query	todo, doing, done
priority	query	urgent, high, medium, low
assignee_id	query	UUID do membro
include_done	query	true/false (default: false)

POST/api/v1/spaces/{spaceId}/tasks— Cria nova tarefa

Param	Tipo	Descrição / Valores
title	body ✅	Título da tarefa
description	body	Descrição detalhada
priority	body	urgent, high, medium (default), low
due_date	body	ISO 8601 (ex: 2026-03-15T23:59:59Z)
assignee_id	body	UUID do membro
folder_name	body	Nome da pasta (busca fuzzy)
list_name	body	Nome da lista (busca fuzzy)

Exemplo

curl -X POST \
  -H "Authorization: Bearer zk_SUA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Revisar contrato", "priority": "urgent"}' \
  https://crm.grupozark.com.br/api/v1/spaces/UUID/tasks

GET/api/v1/tasks/{taskId}— Ver detalhes completos da tarefa

PATCH/api/v1/tasks/{taskId}— Editar tarefa (somente campos enviados)

Param	Tipo	Descrição / Valores
title	body	Novo título
status	body	todo, doing, done
priority	body	urgent, high, medium, low
due_date	body	ISO 8601 ou null
assignee_id	body	UUID ou null

POST/api/v1/tasks/{taskId}/complete— Marca tarefa como concluída (sem body)

Exemplo

curl -X POST \
  -H "Authorization: Bearer zk_SUA_KEY" \
  https://crm.grupozark.com.br/api/v1/tasks/UUID/complete

💬 Comentários

GET/api/v1/tasks/{taskId}/comments— Lista comentários

POST/api/v1/tasks/{taskId}/comments— Adiciona comentário

Param	Tipo	Descrição / Valores
content	body ✅	Texto do comentário

Exemplo

curl -X POST \
  -H "Authorization: Bearer zk_SUA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content": "Feito via comando de voz"}' \
  https://crm.grupozark.com.br/api/v1/tasks/UUID/comments

Códigos de Erro

Código	Significado
200	Sucesso
201	Recurso criado
400	Campos obrigatórios faltando
401	API Key inválida ou ausente
403	Sem acesso ao recurso
404	Recurso não encontrado
500	Erro interno

🤖 Fluxo para Agentes de IA

1GET /spaces → Identificar o espaço pelo nome

2GET /spaces/{id}/members → Saber quem atribuir

3POST /spaces/{id}/tasks → Criar tarefa

4POST /tasks/{id}/complete → Concluir quando pedido

5POST /tasks/{id}/comments → Registrar observações

Endpoint de Documentação JSON

Agentes de IA podem consumir esta documentação programaticamente:

GET https://crm.grupozark.com.br/api/v1/docs