YourNextHome
API ReferenceEstate

Get all estates

GET
/api/v1/estate

Query Parameters

organizationId?string
buildingId?string
offset?number
limit?number

Response Body

application/json

curl -X GET "https://example.com/api/v1/estate"
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "organizationId": "string",
    "slug": "string",
    "photoUrl": "string",
    "navigatorId": "string",
    "organization": {
      "id": "string",
      "name": "string",
      "featureFlags": [
        "estates"
      ]
    },
    "buildings": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "features": [
          {
            "name": "string",
            "description": "string",
            "type": "parking"
          }
        ],
        "source": "string"
      }
    ],
    "integrationType": "VOX_DEVELOPER",
    "isPreview": true,
    "subscriptionStatus": "DRAFT",
    "manuallyActivatedAt": "string",
    "manuallyActivatedById": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
]