Referência

As 58 rotas da API, por recurso. Cada página traz o que a rota faz, a permissão, os campos, exemplos em seis linguagens e os erros dela.

Conta

A conta dona da chave: plano, cota de imóveis, permissões da chave, limites e o uso do mês.

GET/v1/me— Quem sou eu

Listas de valores

Os valores aceitos em cada campo de código: tipos de imóvel, finalidades, status, etapas, permissões e eventos. São os MESMOS valores do banco — não existe tradução no meio.

GET/v1/reference/property-types— Tipos de imóvel
GET/v1/reference/purposes— Finalidades
GET/v1/reference/property-statuses— Status do imóvel
GET/v1/reference/lead-statuses— Etapas do cliente
GET/v1/reference/partnership-statuses— Etapas da parceria
GET/v1/reference/construction-stages— Estágios da obra
GET/v1/reference/scopes— Permissões
GET/v1/reference/event-types— Tipos de evento

Cidades e bairros

O catálogo de localização: cidade pelo código do IBGE e bairro pelo identificador do catálogo. Bairro é fechado contra o catálogo — é por ele que o imóvel entra nas recomendações.

GET/v1/geo/cities— Cidades
GET/v1/geo/cities/{cityId}/neighborhoods— Bairros de uma cidade

Imóveis

A carteira da conta: ler, sincronizar pelo código do seu sistema, mudar status, confirmar disponibilidade, enviar fotos por endereço e mandar para a lixeira.

GET/v1/properties— Listar a carteira
GET/v1/properties/by-ref/{ref}— Um imóvel pelo seu código
GET/v1/properties/{propertyId}— Um imóvel
GET/v1/feed— Estado da sincronização do feed
POST/v1/feed/sync— Sincronizar o feed agora
PUT/v1/properties/by-ref/{ref}— Criar ou atualizar pelo seu código
POST/v1/properties— Cadastrar um imóvel
PATCH/v1/properties/{propertyId}— Alterar parte de um imóvel
POST/v1/properties/{propertyId}/status— Mudar o status
POST/v1/properties/confirm— Confirmar disponibilidade em lote
DELETE/v1/properties/{propertyId}— Mandar para a lixeira

Clientes

Os clientes da conta, com o perfil de busca que liga as recomendações: ler, sincronizar pelo código do seu sistema, mover no funil, arquivar e registrar atendimentos.

GET/v1/leads— Listar clientes
GET/v1/leads/{leadId}— Um cliente
GET/v1/leads/by-ref/{ref}— Um cliente pelo seu código
PUT/v1/leads/by-ref/{ref}— Criar, atualizar ou vincular pelo seu código
POST/v1/leads— Cadastrar um cliente
PATCH/v1/leads/{leadId}— Alterar parte de um cliente
POST/v1/leads/{leadId}/state— Arquivar ou reativar
POST/v1/leads/{leadId}/interactions— Registrar um atendimento
DELETE/v1/leads/{leadId}— Mandar para a lixeira

Oportunidades (Radar)

As oportunidades que o Radar encontra entre imóveis e clientes — da própria carteira e de parceiros —, com a mesma regra de exibição do painel.

GET/v1/properties/{propertyId}/matches— Oportunidades de um imóvel
GET/v1/leads/{leadId}/matches— Oportunidades de um cliente
GET/v1/matches— Oportunidades da conta
POST/v1/matches/{matchId}/dismiss— Descartar oportunidade
POST/v1/matches/{matchId}/restore— Restaurar oportunidade

Parcerias

As parcerias da equipe, com a etapa e as duas pontas. Só o lado que captou o cliente move o funil.

GET/v1/partnerships— Parcerias da equipe
GET/v1/partnerships/{partnershipId}— Uma parceria
POST/v1/partnerships/{partnershipId}/status— Mover a etapa da parceria

Equipe

Quem está na equipe: nome, e-mail, papel e CRECI. É pelo e-mail que o seu sistema reconhece o corretor.

GET/v1/team— A equipe

Lançamentos

O catálogo de lançamentos da cidade: empreendimento, tipologias, tabela e estágio da obra.

GET/v1/launches— Lançamentos da cidade

Captação

Os proprietários que chegam à vez da conta e o aceite, que debita o crédito e libera o contato. Aceitar exige uma permissão própria e o termo específico aceito no painel.

GET/v1/captacao/offers— Proprietários na vez da conta
GET/v1/captacao/offers/{offerId}— Um proprietário
GET/v1/captacao/owners— Proprietários aceitos
POST/v1/captacao/offers/{offerId}/accept— Aceitar um proprietário

Eventos

O que mudou na conta, em ordem, com 30 dias de memória — a sincronização incremental. O evento é enxuto: ids e os nomes dos campos que mudaram; o detalhe vem da leitura do recurso.

GET/v1/events— O que mudou

Webhooks

Os endereços que recebem os eventos na hora, assinados no padrão Standard Webhooks, com nova tentativa, desligamento automático, reenvio e evento de teste.

GET/v1/webhooks— Endereços cadastrados
POST/v1/webhooks— Cadastrar um endereço
PATCH/v1/webhooks/{webhookId}— Alterar um endereço
DELETE/v1/webhooks/{webhookId}— Apagar um endereço
POST/v1/webhooks/{webhookId}/rotate-secret— Trocar o segredo
POST/v1/webhooks/{webhookId}/test— Mandar um evento de teste
GET/v1/webhooks/{webhookId}/deliveries— Entregas de um endereço
POST/v1/webhooks/{webhookId}/deliveries/{deliveryId}/retry— Reenviar uma entrega

Lotes

Até 500 imóveis ou clientes numa chamada, processados no ritmo da plataforma, com o desfecho de cada item.

POST/v1/properties/batch— Lote de imóveis
GET/v1/properties/batch/{batchId}— Acompanhar o lote
POST/v1/leads/batch— Lote de clientes
GET/v1/leads/batch/{batchId}— Acompanhar o lote