AlterEstate API
The AlterEstate API lets you connect websites, property portals, lead forms and internal tools to the AlterEstate real estate CRM.
AlterEstate is a real estate CRM used by agencies and developers across Latin America. The REST API returns JSON and uses the base URL https://secure.alterestate.com/api/v1.
Authentication
The API uses two credentials. Each endpoint page states which one it needs.
| Credential | Header | Used for |
|---|---|---|
| Account token | Authorization: Token <key> | Leads, contacts, deals and property writes. |
| Public token | aetoken: <key> | Reading properties and agents. An administrator generates it. |
| None | — | Cities and sectors. |
Resources
- Contacts: list, retrieve, create and edit
- Deals: list, retrieve, pipelines, edit and round robins
- Properties: search, retrieve, create and edit
- Locations: cities and sectors
- Leads: send a lead to the CRM
- Users: active agents
Pagination
List endpoints for properties, contacts and deals return count, next, previous and results. Pass page to move forward. next is null on the last page.
Errors
| Status | Meaning |
|---|---|
| 200 | The request succeeded. |
| 201 | The resource was created. |
| 400 | The body or a parameter is invalid. The response names the field. |
| 401 | The token is missing or invalid. |
| 404 | The resource or route does not exist. |
| 500 | Server error. Retry, and contact engineering@alterestate.com if it persists. |
Rate limits
The API enforces rate limits to protect the service. If your integration needs more capacity, write to engineering@alterestate.com.
Frequently asked questions
What is the AlterEstate API base URL?
All endpoints live under https://secure.alterestate.com/api/v1 and return JSON.
How do I authenticate with the AlterEstate API?
Send your account token in the Authorization header as "Token <key>" for leads, contacts, deals and property writes. Send the public token in the aetoken header to read properties and agents. Cities and sectors need no token.
Where do I find my AlterEstate public API token?
An administrator can copy it from the AlterEstate dashboard under Settings → Public API Token.
Who do I contact for API support?
Write to engineering@alterestate.com.
Last updated . Questions? Emailengineering@alterestate.com.