Skip to main content
1

Retrieve Client Credentials

Check that you received a client_id and client_secret from the Setle team. We will assume it is for the production environment.Haven’t received the credentials yet? Please contact the Setle team and read more about Client Credentials.
2

Retrieve an Access Token

With these Client Credentials, you can now fetch a new Access Token. Use the /v1/oauth/token API endpoint details.Send a POST request to this endpoint with the Client ID and Client Secret to obtain the Bearer token.Sample Request:
POST /v1/oauth/token
Host: public-api.setle.app
Content-Type: application/json

{
  "client_id": "<your_client_id>",
  "client_secret": "<your_client_secret>"
}
Once obtained, use the Bearer token in the headers for subsequent requests.
3

Retrieve Property Data

You now have a valid token. Let’s use it to retrieve property data.Add the Access Token to the Authorization header as shown below:
Authorization: Bearer <token>
Then, call the Estate List /v1/estate/list endpoint to retrieve a list of properties along with their details.
4

Processing Property Data

Now that you have retrieved property data, here are some tips on processing it:
  • CRM Type: The estate_provider_type attribute indicates the CRM type linked to the property.
  • External ID: Use this attribute to match the ID from the CRM system with property information in Setle.
  • Mapping: Use estate_provider_type and external_id to correctly map property data in your system.
  • Renovation Availability: If the property has a quality_label of D, it is not suitable for renovation. In this case, disable the button leading to the renovation page.
  • CTA Implementation: The referral_link attribute can be used to add a Call-To-Action (CTA) to the client’s website, guiding users to specific information or actions.