Começando

Documentação da API Garagem

Bem-vindo à documentação da API do Garagem, uma plataforma completa de CRM para profissionais do mercado imobiliário.

📖 Novo aqui? Comece pelo Guia Rápido para fazer sua primeira requisição em minutos.

🚀 Começando

Obter sua API Key

  1. Acesse Configurações → Desenvolvedor na sua conta Garagem
  2. Clique em Criar API Key
  3. Dê um nome descritivo (ex: "Integração Site", "Automação Leads")
  4. Copie a chave gerada (ela só será exibida uma vez!)

Autenticação 

Authorization: Bearer sua_api_key_aqui

Base URL 

https://app.garagem.ai/api/v1

📚 Índice da Documentação

Guias

Documento Descrição
01 - Guia Rápido Primeiros passos e primeira requisição
09 - Exemplos Práticos Casos de uso completos com código

CRM

Documento Descrição
02 - Negociações (Deals) CRUD de negociações, funil de vendas, contatos
03 - Tarefas (Tasks) CRUD de tarefas, agendamentos, follow-ups

Imóveis

Documento Descrição
04 - Imóveis (Properties) CRUD de imóveis, características, localização
05 - Anúncios (Listings) CRUD de anúncios, visibilidade, preços

Integrações

Documento Descrição
06 - Campos Customizados Marketing attribution, preferências de busca
07 - Compartilhamento Links públicos, visibilidade de campos, domínios
08 - Webhooks e Eventos Notificações em tempo real
10 - Sites API API pública para WordPress e sites externos
11 - Plugin WordPress Instalação e uso do plugin Garagem (WordPress.org + CRM)

📊 Resumo de Endpoints

CRM 

GET    /api/v1/crm/deals           # Listar negociações
GET    /api/v1/crm/deals/{id}      # Buscar negociação
POST   /api/v1/crm/deals           # Criar negociação
PATCH  /api/v1/crm/deals/{id}      # Atualizar negociação
DELETE /api/v1/crm/deals/{id}      # Deletar negociação

GET    /api/v1/crm/tasks           # Listar tarefas
GET    /api/v1/crm/tasks/{id}      # Buscar tarefa
POST   /api/v1/crm/tasks           # Criar tarefa
PATCH  /api/v1/crm/tasks/{id}      # Atualizar tarefa
DELETE /api/v1/crm/tasks/{id}      # Deletar tarefa

Imóveis 

GET    /api/v1/real-estate/properties/{id}   # Buscar imóvel
POST   /api/v1/real-estate/properties        # Criar imóvel + anúncios
PATCH  /api/v1/real-estate/properties/{id}   # Atualizar imóvel

GET    /api/v1/real-estate/listings          # Listar anúncios
GET    /api/v1/real-estate/listings/{id}     # Buscar anúncio
DELETE /api/v1/real-estate/listings/{id}     # Deletar anúncio

Sites (Público - Sem Autenticação) 

GET    /api/sites/resolve             # Resolver site por domínio ou ID
GET    /api/sites/{siteId}/public-config  # Configuração pública do site
POST   /api/sites/{siteId}/search     # Buscar imóveis (Typesense)
GET    /api/sites/{siteId}/property/{id}  # Detalhes do imóvel
GET    /api/sites/{siteId}/locations  # Localizações disponíveis
GET    /api/sites/share/{token}       # Resolver link de compartilhamento
POST   /api/sites/share/{token}       # Resolver link com senha

🔑 Conceitos Principais

Negociação (Deal)

Representa uma oportunidade de negócio com contatos, etapas do funil e histórico.

{
	"title": "Lead do Site",
	"dealType": "rental",
	"stage": "lead",
	"contacts": [{ "name": "João", "email": "[email protected]", "role": "buyer" }]
}

Imóvel (Property) vs Anúncio (Listing)

  • Property = imóvel físico (quartos, área, localização)
  • Listing = oferta comercial (preço, visibilidade, tipo de transação)
{
	"property": { "type": "apartment", "bedrooms": 2 },
	"listings": [
		{ "type": "rental", "price": "3500", "visibility": "public" },
		{ "type": "sale", "price": "450000", "visibility": "private" }
	]
}

Visibilidade

Campo Valores Descrição
visibility public, private Controla se o anúncio aparece em buscas públicas
priceVisibility public, private Controla se o preço é exibido

📖 Veja 05 - Anúncios para detalhes.

📖 Referência OpenAPI

Especificação completa disponível em:

https://app.garagem.ai/api/docs
Next
Guia Rápido