Reference
The API's 58 routes, by resource. Each page shows what a route does, its permission, the fields, examples in six languages and its errors.
Account
The account that owns the key: plan, property quota, key permissions, limits and monthly usage.
- GET/v1/me— Who am I
Reference lists
The accepted values for each code field: property types, purposes, statuses, stages, permissions and events. They are the SAME values stored by the platform — there is no translation layer.
- GET/v1/reference/property-types— Property types
- GET/v1/reference/purposes— Purposes
- GET/v1/reference/property-statuses— Property statuses
- GET/v1/reference/lead-statuses— Client stages
- GET/v1/reference/partnership-statuses— Partnership stages
- GET/v1/reference/construction-stages— Construction stages
- GET/v1/reference/scopes— Permissions
- GET/v1/reference/event-types— Event types
Cities and neighborhoods
The location catalog: city by its IBGE code and neighborhood by its catalog identifier. Neighborhoods are closed against the catalog — that is what lets a property into recommendations.
- GET/v1/geo/cities— Cities
- GET/v1/geo/cities/{cityId}/neighborhoods— A city's neighborhoods
Properties
The account's portfolio: read, sync by your system's code, change status, confirm availability, send photos by URL and move to the trash.
- GET/v1/properties— List the portfolio
- GET/v1/properties/by-ref/{ref}— One property by your code
- GET/v1/properties/{propertyId}— One property
- GET/v1/feed— Feed sync status
- POST/v1/feed/sync— Sync the feed now
- PUT/v1/properties/by-ref/{ref}— Create or update by your code
- POST/v1/properties— Create a property
- PATCH/v1/properties/{propertyId}— Partially update a property
- POST/v1/properties/{propertyId}/status— Change the status
- POST/v1/properties/confirm— Confirm availability in bulk
- DELETE/v1/properties/{propertyId}— Move to the trash
Clients
The account's clients, with the search profile that drives recommendations: read, sync by your system's code, move through the funnel, archive and log interactions.
- GET/v1/leads— List clients
- GET/v1/leads/{leadId}— One client
- GET/v1/leads/by-ref/{ref}— One client by your code
- PUT/v1/leads/by-ref/{ref}— Create, update or link by your code
- POST/v1/leads— Create a client
- PATCH/v1/leads/{leadId}— Partially update a client
- POST/v1/leads/{leadId}/state— Archive or reactivate
- POST/v1/leads/{leadId}/interactions— Log an interaction
- DELETE/v1/leads/{leadId}— Move to the trash
Opportunities (Radar)
The opportunities Radar finds between properties and clients — in the account itself and with partners — under the same display rules as the dashboard.
- GET/v1/properties/{propertyId}/matches— A property's opportunities
- GET/v1/leads/{leadId}/matches— A client's opportunities
- GET/v1/matches— The account's opportunities
- POST/v1/matches/{matchId}/dismiss— Dismiss an opportunity
- POST/v1/matches/{matchId}/restore— Restore an opportunity
Partnerships
The team's partnerships, with the stage and both sides. Only the side that brought the client moves the funnel.
- GET/v1/partnerships— The team's partnerships
- GET/v1/partnerships/{partnershipId}— One partnership
- POST/v1/partnerships/{partnershipId}/status— Move the partnership stage
Team
Who is on the team: name, e-mail, role and broker license. Your system matches the broker by e-mail.
- GET/v1/team— The team
Launches
The city's new-development catalog: development, unit types, price list and construction stage.
- GET/v1/launches— The city's new developments
Captação (owner leads)
Property owners offered to the account and the acceptance, which debits credit and reveals the contact. Accepting requires its own permission and the specific term accepted in the dashboard.
- GET/v1/captacao/offers— Owners offered to the account
- GET/v1/captacao/offers/{offerId}— One owner
- GET/v1/captacao/owners— Accepted owners
- POST/v1/captacao/offers/{offerId}/accept— Accept an owner
Events
What changed in the account, in order, with 30 days of history — incremental sync. Events are lean: ids and the names of the changed fields; the detail comes from reading the resource.
- GET/v1/events— What changed
Webhooks
The endpoints that receive events right away, signed with the Standard Webhooks spec, with retries, automatic disabling, redelivery and a test event.
- GET/v1/webhooks— Registered endpoints
- POST/v1/webhooks— Register an endpoint
- PATCH/v1/webhooks/{webhookId}— Update an endpoint
- DELETE/v1/webhooks/{webhookId}— Delete an endpoint
- POST/v1/webhooks/{webhookId}/rotate-secret— Rotate the secret
- POST/v1/webhooks/{webhookId}/test— Send a test event
- GET/v1/webhooks/{webhookId}/deliveries— An endpoint's deliveries
- POST/v1/webhooks/{webhookId}/deliveries/{deliveryId}/retry— Redeliver
Batches
Up to 500 properties or clients in one call, processed at the platform pace, with the outcome of each item.
- POST/v1/properties/batch— Batch of properties
- GET/v1/properties/batch/{batchId}— Track the batch
- POST/v1/leads/batch— Batch of clients
- GET/v1/leads/batch/{batchId}— Track the batch