> 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/api/rest-api/scaleapp-rest-api/goals.md).

# Goals

Setting and tracking property and financial goals

## Get all user goals

> Retrieves list of all goals with progress, costs, and details.

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Goals","description":"Setting and tracking property and financial goals"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GoalListResponseDto":{"type":"object","properties":{"data":{"description":"Array of user goals","type":"array","items":{"$ref":"#/components/schemas/GoalResponseDto"}}},"required":["data"]},"GoalResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Goal identifier"},"type":{"type":"string","description":"Type of goal"},"name":{"type":"string","description":"Goal name/description"},"savingStyle":{"type":"string","description":"Saving style/strategy"},"purchasePrice":{"type":"number","description":"Target purchase price"},"state":{"type":"string","description":"Property state/territory"},"propertyType":{"type":"string","description":"Property type"},"lotType":{"type":"string","description":"Land/lot type"},"depositAmount":{"type":"number","description":"Required deposit amount"},"stampDuty":{"type":"number","description":"Stamp duty amount"},"lmiAmount":{"type":"number","description":"Lenders Mortgage Insurance amount"},"otherExpenses":{"type":"number","description":"Other acquisition expenses"},"totalAcquisitionCosts":{"type":"number","description":"Total acquisition costs"},"firstHomeBuyer":{"type":"boolean","description":"Whether user is first home buyer"},"createdAt":{"type":"string","description":"When goal was created","format":"date-time"},"updatedAt":{"type":"string","description":"When goal was last updated","format":"date-time"}},"required":["id","type","name","savingStyle","purchasePrice","state","propertyType","lotType","depositAmount","stampDuty","lmiAmount","otherExpenses","totalAcquisitionCosts","firstHomeBuyer","createdAt","updatedAt"]}}},"paths":{"/v1/goals":{"get":{"description":"Retrieves list of all goals with progress, costs, and details.","operationId":"GoalController_listGoals_v1","parameters":[{"name":"strategy","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved goals","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalListResponseDto"}}}},"401":{"description":"Unauthorized"}},"summary":"Get all user goals","tags":["Goals"]}}}}
```

## Create new property/financial goal

> Creates a new goal for property purchase with all acquisition cost calculations.

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Goals","description":"Setting and tracking property and financial goals"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateGoalDto":{"type":"object","properties":{"type":{"type":"string","enum":["HOME","INVESTMENT"]},"name":{"type":"string"},"savingStyle":{"type":"string","enum":["CASH_AND_EQUITY","CASH_ONLY"]},"purchasePrice":{"type":"number"},"state":{"type":"string"},"propertyType":{"type":"string","enum":["HOUSE","DUPLEX","APARTMENT","MULTI_FAMILY","LAND","TOWNHOUSE","VILLA"]},"lotType":{"type":"string","enum":["NEW_HOME","ESTABLISHED","VACANT_LAND"]},"depositAmount":{"type":"number","default":0,"nullable":true},"depositPercent":{"type":"number","default":0,"nullable":true},"stampDuty":{"type":"number"},"lmiAmount":{"type":"number","default":0,"nullable":true},"lmiPercent":{"type":"number","default":0,"nullable":true},"otherExpenses":{"type":"number"},"totalAcquisitionCosts":{"type":"number"},"firstHomeBuyer":{"type":"boolean"}},"required":["type","name","savingStyle","purchasePrice","state","propertyType","lotType","depositAmount","depositPercent","stampDuty","lmiAmount","lmiPercent","otherExpenses","totalAcquisitionCosts","firstHomeBuyer"]},"GoalResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Goal identifier"},"type":{"type":"string","description":"Type of goal"},"name":{"type":"string","description":"Goal name/description"},"savingStyle":{"type":"string","description":"Saving style/strategy"},"purchasePrice":{"type":"number","description":"Target purchase price"},"state":{"type":"string","description":"Property state/territory"},"propertyType":{"type":"string","description":"Property type"},"lotType":{"type":"string","description":"Land/lot type"},"depositAmount":{"type":"number","description":"Required deposit amount"},"stampDuty":{"type":"number","description":"Stamp duty amount"},"lmiAmount":{"type":"number","description":"Lenders Mortgage Insurance amount"},"otherExpenses":{"type":"number","description":"Other acquisition expenses"},"totalAcquisitionCosts":{"type":"number","description":"Total acquisition costs"},"firstHomeBuyer":{"type":"boolean","description":"Whether user is first home buyer"},"createdAt":{"type":"string","description":"When goal was created","format":"date-time"},"updatedAt":{"type":"string","description":"When goal was last updated","format":"date-time"}},"required":["id","type","name","savingStyle","purchasePrice","state","propertyType","lotType","depositAmount","stampDuty","lmiAmount","otherExpenses","totalAcquisitionCosts","firstHomeBuyer","createdAt","updatedAt"]}}},"paths":{"/v1/goals":{"post":{"description":"Creates a new goal for property purchase with all acquisition cost calculations.","operationId":"GoalController_createGoal_v1","parameters":[{"name":"strategyId","required":true,"in":"query","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGoalDto"}}}},"responses":{"201":{"description":"Goal successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"summary":"Create new property/financial goal","tags":["Goals"]}}}}
```

## Start/activate a goal

> Activates a goal to start tracking progress.

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Goals","description":"Setting and tracking property and financial goals"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GoalResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Goal identifier"},"type":{"type":"string","description":"Type of goal"},"name":{"type":"string","description":"Goal name/description"},"savingStyle":{"type":"string","description":"Saving style/strategy"},"purchasePrice":{"type":"number","description":"Target purchase price"},"state":{"type":"string","description":"Property state/territory"},"propertyType":{"type":"string","description":"Property type"},"lotType":{"type":"string","description":"Land/lot type"},"depositAmount":{"type":"number","description":"Required deposit amount"},"stampDuty":{"type":"number","description":"Stamp duty amount"},"lmiAmount":{"type":"number","description":"Lenders Mortgage Insurance amount"},"otherExpenses":{"type":"number","description":"Other acquisition expenses"},"totalAcquisitionCosts":{"type":"number","description":"Total acquisition costs"},"firstHomeBuyer":{"type":"boolean","description":"Whether user is first home buyer"},"createdAt":{"type":"string","description":"When goal was created","format":"date-time"},"updatedAt":{"type":"string","description":"When goal was last updated","format":"date-time"}},"required":["id","type","name","savingStyle","purchasePrice","state","propertyType","lotType","depositAmount","stampDuty","lmiAmount","otherExpenses","totalAcquisitionCosts","firstHomeBuyer","createdAt","updatedAt"]}}},"paths":{"/v1/goals/{id}/start":{"put":{"description":"Activates a goal to start tracking progress.","operationId":"GoalController_startGoal_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Goal identifier (UUID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Goal successfully started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalResponseDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Goal not found"}},"summary":"Start/activate a goal","tags":["Goals"]}}}}
```

## Get specific goal by ID

> Retrieves detailed information for a single goal.

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Goals","description":"Setting and tracking property and financial goals"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GoalResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Goal identifier"},"type":{"type":"string","description":"Type of goal"},"name":{"type":"string","description":"Goal name/description"},"savingStyle":{"type":"string","description":"Saving style/strategy"},"purchasePrice":{"type":"number","description":"Target purchase price"},"state":{"type":"string","description":"Property state/territory"},"propertyType":{"type":"string","description":"Property type"},"lotType":{"type":"string","description":"Land/lot type"},"depositAmount":{"type":"number","description":"Required deposit amount"},"stampDuty":{"type":"number","description":"Stamp duty amount"},"lmiAmount":{"type":"number","description":"Lenders Mortgage Insurance amount"},"otherExpenses":{"type":"number","description":"Other acquisition expenses"},"totalAcquisitionCosts":{"type":"number","description":"Total acquisition costs"},"firstHomeBuyer":{"type":"boolean","description":"Whether user is first home buyer"},"createdAt":{"type":"string","description":"When goal was created","format":"date-time"},"updatedAt":{"type":"string","description":"When goal was last updated","format":"date-time"}},"required":["id","type","name","savingStyle","purchasePrice","state","propertyType","lotType","depositAmount","stampDuty","lmiAmount","otherExpenses","totalAcquisitionCosts","firstHomeBuyer","createdAt","updatedAt"]}}},"paths":{"/v1/goals/{id}":{"get":{"description":"Retrieves detailed information for a single goal.","operationId":"GoalController_getGoalById_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Goal identifier (UUID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved goal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalResponseDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Goal not found"}},"summary":"Get specific goal by ID","tags":["Goals"]}}}}
```

## Update existing goal

> Updates goal parameters such as target amount, purchase price, or other details.

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Goals","description":"Setting and tracking property and financial goals"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateGoalDto":{"type":"object","properties":{"type":{"type":"string","enum":["HOME","INVESTMENT"]},"name":{"type":"string"},"savingStyle":{"type":"string","enum":["CASH_AND_EQUITY","CASH_ONLY"]},"purchasePrice":{"type":"number"},"state":{"type":"string"},"propertyType":{"type":"string","enum":["HOUSE","DUPLEX","APARTMENT","MULTI_FAMILY","LAND","TOWNHOUSE","VILLA"]},"lotType":{"type":"string","enum":["NEW_HOME","ESTABLISHED","VACANT_LAND"]},"depositAmount":{"type":"number","default":0,"nullable":true},"depositPercent":{"type":"number","default":0,"nullable":true},"stampDuty":{"type":"number"},"lmiAmount":{"type":"number","default":0,"nullable":true},"lmiPercent":{"type":"number","default":0,"nullable":true},"otherExpenses":{"type":"number"},"totalAcquisitionCosts":{"type":"number"},"firstHomeBuyer":{"type":"boolean"}}},"GoalResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Goal identifier"},"type":{"type":"string","description":"Type of goal"},"name":{"type":"string","description":"Goal name/description"},"savingStyle":{"type":"string","description":"Saving style/strategy"},"purchasePrice":{"type":"number","description":"Target purchase price"},"state":{"type":"string","description":"Property state/territory"},"propertyType":{"type":"string","description":"Property type"},"lotType":{"type":"string","description":"Land/lot type"},"depositAmount":{"type":"number","description":"Required deposit amount"},"stampDuty":{"type":"number","description":"Stamp duty amount"},"lmiAmount":{"type":"number","description":"Lenders Mortgage Insurance amount"},"otherExpenses":{"type":"number","description":"Other acquisition expenses"},"totalAcquisitionCosts":{"type":"number","description":"Total acquisition costs"},"firstHomeBuyer":{"type":"boolean","description":"Whether user is first home buyer"},"createdAt":{"type":"string","description":"When goal was created","format":"date-time"},"updatedAt":{"type":"string","description":"When goal was last updated","format":"date-time"}},"required":["id","type","name","savingStyle","purchasePrice","state","propertyType","lotType","depositAmount","stampDuty","lmiAmount","otherExpenses","totalAcquisitionCosts","firstHomeBuyer","createdAt","updatedAt"]}}},"paths":{"/v1/goals/{id}":{"put":{"description":"Updates goal parameters such as target amount, purchase price, or other details.","operationId":"GoalController_updateGoal_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Goal identifier (UUID)","schema":{"type":"string"}},{"name":"strategyId","required":true,"in":"query","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGoalDto"}}}},"responses":{"200":{"description":"Goal successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Goal not found"}},"summary":"Update existing goal","tags":["Goals"]}}}}
```

## Delete goal

> Permanently deletes a goal.

```json
{"openapi":"3.0.0","info":{"title":"ScaleApp API","version":"1.0.0"},"tags":[{"name":"Goals","description":"Setting and tracking property and financial goals"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/v1/goals/{id}":{"delete":{"description":"Permanently deletes a goal.","operationId":"GoalController_deleteGoal_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Goal identifier (UUID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Goal successfully deleted"},"401":{"description":"Unauthorized"},"404":{"description":"Goal not found"}},"summary":"Delete goal","tags":["Goals"]}}}}
```


---

# 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/api/rest-api/scaleapp-rest-api/goals.md?ask=<question>&goal=<user_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.