Settld API Documentation (1.0.0)

Download OpenAPI specification:

API Support: contact@settld.com.au URL: https://www.settld.com.au/about

Introduction

Settld’s REST API is a service that allows third parties to integrate with Settld’s platform.

Environment

The API provides two environments: Production and Staging/Sandbox.

Name	Environment URL
Production	https://api.settld.com.au/v1
Staging/Sandbox	https://api.settld.app/v1

Authentication

In order to use the API, the consumer will be provided with an API Key, DeveloperUUID and ProjectUUID in the request header

apiKey

Security Scheme Type: API Key

Header parameter name: x-api-key

DeveloperUUID

Security Scheme Type: API Key

Header parameter name: DeveloperUUID

ProjectUUID

Security Scheme Type: API Key

Header parameter name: ProjectUUID

All buyers

Fetch buyers for the specified project

Returns a list of buyers for the specified project

Authorizations:

(apiKeyDeveloperUUIDProjectUUID)

Responses

Response samples

Content type

application/json

{"data": [{"id": "f72ef452-32a3-49e9-854d-6eef2df8b649",
"property": {"stage": 1,
"floor": 1,
"doorNumber": "301",
"unitType": "2B",
"lot": "301"
},
"buyer": {"firstName": "Claire",
"familyName": "Martinez",
"mobile": "0411111111",
"email": "claire.martinez@settld.com.au",
"address": "111 Test Street, Sydney, 2000 NSW",
"buyerType": "Pending"
},
"contract": {"purchasePrice": "1500000.00",
"dateOfExchange": "2025-06-11",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Light"
},
"dimensions": {"intSqm": "82.00",
"extSqm": "10.00",
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Troy Collins",
"email": "troy@rayw.com.au",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Martin Scorcese",
"email": "ms@lawyers.com.au",
"phone": "412222222"
},
"metadata": {"createdAt": "2025-06-11T06:02:08.000000Z",
"updatedAt": "2025-06-11T06:02:08.000000Z"
}
},
{"id": "2e5929ea-50aa-4a6e-80fe-96dd4d9e24e7",
"property": {"stage": 1,
"doorNumber": "302",
"unitType": "2B",
"lot": "302"
},
"buyer": {"firstName": "Kylie",
"familyName": "Ventura",
"mobile": "0411111112",
"email": "kylie.ventura@settld.com.au",
"address": "112 Test Street, Sydney, 2000 NSW",
"buyerType": "Pending"
},
"contract": {"purchasePrice": "1500000.00",
"dateOfExchange": "2025-06-11",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Light"
},
"dimensions": {"intSqm": "82.00",
"extSqm": "10.00",
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Troy Collins",
"email": "troy@rayw.com.au",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Martin Scorcese",
"email": "ms@lawyers.com.au",
"phone": "412222222"
},
"metadata": {"createdAt": "2025-06-11T06:02:08.000000Z",
"updatedAt": "2025-06-11T06:02:08.000000Z"
}
},
{"id": "6b7873d8-a2a0-4d37-817c-5164f6f29680",
"property": {"stage": 1,
"doorNumber": "303",
"unitType": "2B",
"lot": "303"
},
"buyer": {"firstName": "Trent",
"familyName": "Johnson",
"mobile": "0411111113",
"email": "trent.johnson@settld.com.au",
"address": "113 Test Street, Sydney, 2000 NSW",
"buyerType": "Pending"
},
"contract": {"purchasePrice": "1500000.00",
"dateOfExchange": "2025-06-11",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Light"
},
"dimensions": {"intSqm": "82.00",
"extSqm": "10.00",
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Troy Collins",
"email": "troy@rayw.com.au",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Martin Scorcese",
"email": "ms@lawyers.com.au",
"phone": "412222222"
},
"metadata": {"createdAt": "2025-06-11T06:02:08.000000Z",
"updatedAt": "2025-06-11T06:02:08.000000Z"
}
},
{"id": "d4c00cb8-d1a5-4f93-ad11-795359ac5c8d",
"property": {"stage": 1,
"doorNumber": "304",
"unitType": "2B",
"lot": "304"
},
"buyer": {"firstName": "Samuel",
"familyName": "Smith",
"mobile": "0411111114",
"email": "samuel.smith@settld.com.au",
"address": "114 Test Street, Sydney, 2000 NSW",
"buyerType": "Pending"
},
"contract": {"purchasePrice": "1500000.00",
"dateOfExchange": "2025-06-11",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Light"
},
"dimensions": {"intSqm": "82.00",
"extSqm": "10.00",
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Troy Collins",
"email": "troy@rayw.com.au",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Martin Scorcese",
"email": "ms@lawyers.com.au",
"phone": "412222222"
},
"metadata": {"createdAt": "2025-06-11T06:02:08.000000Z",
"updatedAt": "2025-06-11T06:02:08.000000Z"
}
},
{"id": "3463dc2c-af35-4bea-b0aa-895a62680aac",
"property": {"stage": 1,
"doorNumber": "305",
"unitType": "2B",
"lot": "305"
},
"buyer": {"firstName": "Samuel",
"familyName": "Baskin",
"mobile": "0411111115",
"email": "leo.baskin@settld.com.au",
"address": "115 Test Street, Sydney, 2000 NSW",
"buyerType": "Pending"
},
"contract": {"purchasePrice": "1500000.00",
"dateOfExchange": "2025-06-11",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Light"
},
"dimensions": {"intSqm": "82.00",
"extSqm": "10.00",
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Troy Collins",
"email": "troy@rayw.com.au",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Martin Scorcese",
"email": "ms@lawyers.com.au",
"phone": "412222222"
},
"metadata": {"createdAt": "2025-06-11T06:02:08.000000Z",
"updatedAt": "2025-06-11T06:02:08.000000Z"
}
},
{"id": "2b8430a4-f52f-4b29-87c3-bb95b1ebd211",
"property": {"stage": 1,
"doorNumber": "306",
"unitType": "2B",
"lot": "306"
},
"buyer": {"firstName": "Eli",
"familyName": "Patrick",
"mobile": "0411111116",
"email": "eli.patrick@settld.com.au",
"address": "116 Test Street, Sydney, 2000 NSW",
"buyerType": "Pending"
},
"contract": {"purchasePrice": "1500000.00",
"dateOfExchange": "2025-06-11",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Light"
},
"dimensions": {"intSqm": "82.00",
"extSqm": "10.00",
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Troy Collins",
"email": "troy@rayw.com.au",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Martin Scorcese",
"email": "ms@lawyers.com.au",
"phone": "412222222"
},
"metadata": {"createdAt": "2025-06-11T06:02:08.000000Z",
"updatedAt": "2025-06-11T06:02:08.000000Z"
}
}
]
}

Create new buyer(s)

Create new buyer(s) for the specified project

Create new buyer(s) for the specified project. Buyers are expected to be an array of objects.

How we prevent data duplication

The system checks the buyer email and the property's stage and door number before creating new records.

If the buyer email already exists, we update and reuse that buyer instead of creating another buyer.

If a property with the same stage and door number already exists in the project, we update and reuse that property instead of creating another property.

If the same buyer email is already linked to the same property stage and door number, we update that existing buyer-property record.

If the buyer email exists and the property stage and door number exist but they are not linked yet, we link the existing buyer to the existing property and create or update the related buyer-property details.

If two different buyers are submitted for the same property stage and door number, each buyer is saved separately, but they share the same property record.

Authorizations:

(apiKeyDeveloperUUIDProjectUUID)

Request Body schema: application/json

required

Array of objects

Array of buyers to create

Responses

Request samples

Payload

Content type

application/json

{"buyers": [{"property": {"stage": 1,
"floor": 1,
"doorNumber": "A12",
"unitType": "2B",
"lot": "202"
},
"buyer": {"firstName": "John",
"familyName": "Smith",
"mobile": "0400000000",
"email": "john.smith@example.com",
"address": "10 Smith St",
"buyerType": "Owner Occupier"
},
"contract": {"purchasePrice": "780000.00",
"dateOfExchange": "2025-03-01",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Coastal"
},
"dimensions": {"intSqm": 78,
"extSqm": 12,
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Alice Cooper",
"email": "alice@raywhite.com",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Mark Smith",
"email": "mark@smithlegal.com",
"phone": "0298765432"
}
}
]
}

Response samples

Content type

application/json

{"data": [{"id": "7799ab46-46a3-4fbf-81d0-69762ecb7b6b",
"property": {"stage": 1,
"floor": 1,
"doorNumber": "A12",
"unitType": "2B",
"lot": "202"
},
"buyer": {"firstName": "John",
"familyName": "Smith",
"mobile": "0400000000",
"email": "john.smith@example.com",
"address": "10 Smith St",
"buyerType": "Owner Occupier"
},
"contract": {"purchasePrice": "780000.00",
"dateOfExchange": "2025-03-01",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Coastal"
},
"dimensions": {"intSqm": "78.00",
"extSqm": "12.00",
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Alice Cooper",
"email": "alice@raywhite.com",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Mark Smith",
"email": "mark@smithlegal.com",
"phone": "0298765432"
},
"metadata": {"createdAt": "2025-12-10T10:30:04.000000Z",
"updatedAt": "2025-12-10T10:30:04.000000Z"
}
}
]
}

Get a buyer

Fetch a single buyer

Returns a buyer specified by the buyerUUID

Authorizations:

(apiKeyDeveloperUUIDProjectUUID)

Responses

Response samples

Content type

application/json

{"data": {"id": "f72ef452-32a3-49e9-854d-6eef2df8b649",
"property": {"stage": 1,
"floor": 1,
"doorNumber": "301",
"unitType": "2B",
"lot": "301"
},
"buyer": {"firstName": "Claire",
"familyName": "Martinez",
"mobile": "0411111111",
"email": "claire.martinez@settld.com.au",
"address": "111 Test Street, Sydney, 2000 NSW",
"buyerType": "Pending"
},
"contract": {"purchasePrice": "1500000.00",
"dateOfExchange": "2025-06-11",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Light"
},
"dimensions": {"intSqm": "82.00",
"extSqm": "10.00",
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Troy Collins",
"email": "troy@rayw.com.au",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Martin Scorcese",
"email": "ms@lawyers.com.au",
"phone": "412222222"
},
"metadata": {"createdAt": "2025-06-11T06:02:08.000000Z",
"updatedAt": "2025-06-11T06:02:08.000000Z"
}
}
}

Update buyer

Update a buyer specified by the buyerUUID

Authorizations:

(apiKeyDeveloperUUIDProjectUUID)

Request Body schema: application/json

required	object
required	object
	object
	object
required	object
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"property": {"stage": 1,
"floor": 1,
"doorNumber": "A12",
"unitType": "2B",
"lot": "202"
},
"buyer": {"firstName": "John",
"familyName": "Smith",
"mobile": "0400000000",
"email": "john.smith@example.com",
"address": "10 Smith St",
"buyerType": "Owner Occupier"
},
"contract": {"purchasePrice": "780000.00",
"dateOfExchange": "2025-03-01",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Coastal"
},
"dimensions": {"intSqm": 78,
"extSqm": 12,
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Alice Cooper",
"email": "alice@raywhite.com",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Mark Smith",
"email": "mark@smithlegal.com",
"phone": "0298765432"
}
}

Response samples

Content type

application/json

{"data": {"id": "f72ef452-32a3-49e9-854d-6eef2df8b649",
"property": {"stage": 1,
"floor": 1,
"doorNumber": "A12",
"unitType": "2B",
"lot": "202"
},
"buyer": {"firstName": "John",
"familyName": "Smith",
"mobile": "0400000000",
"email": "john.smith@example.com",
"address": "10 Smith St",
"buyerType": "Owner Occupier"
},
"contract": {"purchasePrice": "780000.00",
"dateOfExchange": "2025-03-01",
"settlementNoticePeriodDays": 21,
"colourSchemeSelection": "Coastal"
},
"dimensions": {"intSqm": 78,
"extSqm": 12,
"carBays": 1
},
"firb": {"required": true
},
"sellingAgent": {"agency": "Ray White",
"name": "Alice Cooper",
"email": "alice@raywhite.com",
"phone": "0401234567"
},
"buyerSolicitor": {"firm": "Smith Legal",
"name": "Mark Smith",
"email": "mark@smithlegal.com",
"phone": "0298765432"
},
"metadata": {"createdAt": "2025-06-11T06:02:08.000000Z",
"updatedAt": "2025-12-10T11:05:00.000000Z"
}
}
}