Skip to main content
GET
/
v1
/
property
/
list
List Properties
curl --request GET \
  --url https://api.bricked.ai/v1/property/list \
  --header 'x-api-key: <api-key>'
{
  "properties": [
    {
      "id": "<string>",
      "address": "<string>",
      "createdAt": "<string>"
    }
  ],
  "nextPage": 123,
  "hasMore": true
}
Use this endpoint to list all properties created via API.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer

Pagination offset page index (0-based)

Response

200 - application/json

List of properties

​
properties
object[]

Paginated property summaries

​
nextPage
integer

Next page index when available

​
hasMore
boolean

True when more pages exist