> For the complete documentation index, see [llms.txt](https://docs.scaleconnect.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleconnect.com.au/scaleconnect-docs/developer-docs/open-api.md). # Open API ScaleConnect exposes a full REST API that powers both the broker platform and the consumer-facing ScaleApp. The same endpoints that drive the dashboard, simulator, AI reviews, and client management are available for you to build custom integrations, connect external tools, and extend the platform to fit your practice. API documentation is available via Swagger at the `/api` path of your ScaleConnect instance. *** ## What the API Offers The ScaleConnect API is a comprehensive REST interface covering every major feature of the platform. It follows standard REST conventions with JSON request and response bodies, URI-based versioning, and Bearer token authentication. Key characteristics: * **Full feature coverage** — the API is not a limited subset. Everything you can do in the ScaleConnect UI has a corresponding API endpoint. * **URI versioning** — all endpoints are prefixed with `/v1/`. Future breaking changes will be introduced under new version prefixes. * **Australian financial year** — date-based calculations (cashflows, tax projections, financial year summaries) use the Australian financial year: 1 July to 30 June. * **OpenAPI/Swagger documentation** — interactive API docs are available at `/api`, where you can explore endpoints, view request/response schemas, and test calls directly. *** ## Who It's For The API is designed for three primary audiences: ### Enterprise teams Brokerages with in-house development capability can use the API to build custom dashboards, reporting pipelines, or client management workflows that go beyond what the standard ScaleConnect UI provides. Pull client data into your own data warehouse, build custom commission reports, or create internal tools tailored to your team's processes. ### Developers and integration partners If you're connecting ScaleConnect to a CRM (like Microsoft Dynamics or Salesforce), a reporting tool, or an internal dashboard, the API provides the structured data layer you need. Push client updates, pull portfolio data, sync events, and automate workflows across systems. ### AI agents and automation tools AI assistants and automation platforms can interact with ScaleConnect data through the API. Whether you're building a custom AI agent that analyses client portfolios, an automated reporting pipeline, or a chatbot that answers questions about client data, the API provides structured access to everything the platform knows. See [Model Context Protocol](/scaleconnect-docs/developer-docs/mcp.md) for guidance on connecting AI tools specifically. *** ## Available Endpoint Groups The API is organised into logical groups, each covering a domain of the platform. Below is a high-level overview of what's available. Full endpoint details, parameters, and response schemas are in the Swagger documentation. | Group | What it covers | | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | Login, token refresh, session management | | **Timeline** | 60+ endpoints covering the client's financial timeline — events, milestones, projections | | **Property Management** | CRUD operations for properties — add, update, remove, and retrieve property details | | **Property Cashflow** | Rental income, expenses, loan repayments, net cashflow calculations per property | | **Property Search (PropTrack)** | Property valuation lookups and suburb-level market data powered by PropTrack | | **Simulation** | Run strategy simulations — create scenarios, add events, calculate projections | | **Goals** | Client goal management — create, update, track progress | | **User Profile** | Client profile data — personal details, income, expenses, dependents | | **Personal Cashflow** | Non-property income and expenses — salary, living costs, savings, superannuation | | **Charts** | Data endpoints that power the dashboard and simulator charts — growth, equity, cashflow over time | | **Connect** | Broker-specific endpoints — dashboard metrics, commission data, client list, team management | | **Google Calendar** | Calendar sync, event creation, availability checking — see [Google Calendar](/scaleconnect-docs/integrations/google-calendar.md) | | **Agent Sessions** | AI conversation sessions — create, retrieve, and manage ScaleAI interactions | | **Chat** | Client messaging — send and retrieve messages in the ScaleApp chat thread | | **Subscriptions** | Subscription and billing management | {% hint style="info" %} The Timeline group alone contains over 60 endpoints. It's the most comprehensive section of the API and covers everything from adding a property purchase event to projecting a client's net worth 30 years into the future. Start here if you're building anything related to client financial modelling. {% endhint %} *** ## Authentication All API requests require a valid Bearer token in the `Authorization` header. ### Obtaining a token 1. Call the authentication endpoint with valid credentials (email and password). 2. The response includes a JWT (JSON Web Token) with an expiration time. 3. Include this token in all subsequent requests as: `Authorization: Bearer `. 4. When the token approaches expiry, call the refresh endpoint to obtain a new one without re-authenticating. ### Token lifecycle | Stage | What happens | | ----------- | -------------------------------------------------------------- | | **Issue** | Token is returned after successful authentication | | **Use** | Include in the `Authorization` header of every API request | | **Refresh** | Call the refresh endpoint before expiry to get a new token | | **Expire** | Expired tokens are rejected with a `401 Unauthorized` response | {% hint style="info" %} Store tokens securely and never expose them in client-side code or public repositories. Treat your API token with the same care as a password — it provides full access to your ScaleConnect data. {% endhint %} *** ## Rate Limits and Usage ### Current policy ScaleConnect does not currently enforce explicit rate limits on API requests. This policy is subject to change as usage patterns evolve. Design your integrations to be respectful of shared infrastructure: * Avoid unnecessary polling — use reasonable intervals for data refresh (e.g., every 5–15 minutes, not every second) * Batch operations where possible rather than making individual requests for each item * Cache responses locally when the underlying data doesn't change frequently ### Request validation All requests pass through a whitelist validation layer. Malformed requests — missing required fields, invalid data types, or unsupported parameters — are rejected with descriptive error responses. The Swagger documentation specifies required fields and valid values for every endpoint. ### CORS Cross-Origin Resource Sharing (CORS) is enabled on the API. Browser-based applications can make direct API calls without encountering cross-origin restrictions. This means you can build client-side tools, browser extensions, or single-page applications that interact with the ScaleConnect API directly. *** ## Working with the API ### Base URL Your API base URL depends on your ScaleConnect environment. The Swagger documentation at `/api` is served from the same base URL and will reflect the correct host. ### Request format * **Content type:** `application/json` for request bodies * **Method conventions:** `GET` for retrieval, `POST` for creation, `PUT`/`PATCH` for updates, `DELETE` for removal * **Date format:** ISO 8601 (`YYYY-MM-DD` or `YYYY-MM-DDTHH:mm:ssZ`) * **Currency:** All monetary values are in Australian Dollars (AUD) unless otherwise specified ### Error responses The API returns standard HTTP status codes: | Code | Meaning | | ------- | ------------------------------------------------------- | | **200** | Success | | **201** | Created | | **400** | Bad request — check your request body and parameters | | **401** | Unauthorized — token is missing, invalid, or expired | | **403** | Forbidden — you don't have permission for this resource | | **404** | Not found — the requested resource doesn't exist | | **500** | Server error — something went wrong on our end | Error responses include a JSON body with a message field describing what went wrong. ### Pagination Endpoints that return lists support pagination. Check the Swagger documentation for each endpoint's pagination parameters (typically `page` and `limit`) and response metadata (total count, current page, total pages). *** ## Common Integration Patterns ### CRM sync Pull client data from ScaleConnect and push it to your CRM. Use the Connect and User Profile endpoint groups to retrieve client lists and details, then map them to your CRM's data model. Schedule a periodic sync (e.g., every 15 minutes) to keep systems aligned. ### Custom reporting Use the Charts and Connect endpoint groups to pull dashboard metrics, commission data, and portfolio analytics into a reporting tool like Power BI, Tableau, or Google Sheets. The Charts endpoints return the same data that powers ScaleConnect's built-in visualisations. ### Automated workflows Combine the Timeline, Simulation, and Agent Sessions endpoints to build automated workflows. For example: detect when a client's fixed rate expires (Timeline), generate a refinance simulation (Simulation), and send the results through the chat (Chat). ***
Is there a sandbox or test environment? Contact the ScaleConnect team to discuss access to a development environment for integration testing. Production API credentials should not be used for experimentation.
Can I create clients through the API? Yes. The Connect endpoint group includes endpoints for client creation and management. You can onboard clients programmatically, which is useful for bulk imports or CRM-driven workflows.
Are webhooks available? Webhooks are not currently available. For event-driven integrations, poll the relevant endpoints at a reasonable interval or use [Zapier](/scaleconnect-docs/integrations/custom-integrations/zapier.md) for no-code trigger-based automation.
What happens if the API changes? Breaking changes will be introduced under a new version prefix (e.g., `/v2/`). The existing `/v1/` endpoints will continue to work for a deprecation period. Non-breaking additions (new fields, new endpoints) may be added to `/v1/` without a version bump.
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.scaleconnect.com.au/scaleconnect-docs/developer-docs/open-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.