GET
/
v1
/
renovations
cURL
curl --request GET \
  --url https://public-api.setle.app/v1/renovations \
  --header 'Authorization: Bearer <token>'
{
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "has_prev_page": true,
  "has_next_page": true,
  "prev_page": 123,
  "next_page": 123,
  "total": 123,
  "data": [
    {
      "renovation_id": "90e6ee5b-3ae1-4c22-88d0-271e228a52ee",
      "renovation_created_at": "2023-11-07T05:31:56Z",
      "renovation_updated_at": "2023-11-07T05:31:56Z",
      "subsidy_amount": 123,
      "estimated_cost": 123,
      "estimated_vat_cost": 123,
      "total_estimated_cost_incl_vat": 123,
      "estate_id": "90e6ee5b-3ae1-4c22-88d0-271e228a52ee",
      "estate_geo_address": {
        "country": "BE",
        "house_number": "<string>",
        "place": "<string>",
        "region": "BE",
        "street": "<string>",
        "zip_code": "<string>"
      },
      "estate_type": "HOUSE",
      "estate_format": "SEMI_OPEN",
      "managing_user": {
        "id": "90e6ee5b-3ae1-4c22-88d0-271e228a52ee",
        "external_id": "<string>"
      },
      "renovation_name": "<string>",
      "renovation_deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
number
default:1
Required range: x >= 1
​
page_size
number
default:50
Required range: 1 <= x <= 100
​
sort_by
enum<string>
default:updated_at
Available options:
created_at,
updated_at
​
sort_order
enum<string>
default:DESC
Available options:
ASC,
DESC
​
filter
any
​
filter[include_deleted]
string

Include deleted renovations

​
filter[external_user_id]
string

External user ID used in your system

Response

200
application/json

Successfully processed request.

The response is of type object.