Properties

Detail about properties created in elyssa app

Listing of all properties with information pagination

GET /v1/property/properties

List the properties that a company has registered in elyssa app; To improve performance, the information is paginated, the amount of data to be returned in each query is established

🤔 Each query returns a maximum of 20 properties

Query Parameters

Name
Type
Description

page*

number

Number of the page to display information. Default 1

pageSize*

number

Number of records to display per page. Default: 20.

code

string

Internal ID for the property, as registered by the agent.

address

string

Address of the property to search

city

string

Property City or State to search

sortBy

string

Default: createdAt

sortOder

string

Values: asc, desc. Desfault: desc

{
  "success": true,
  "timestamp": "2026-02-06T18:36:21.556Z",
  "data": {
    "data": [
      {
        "propertyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "code": "string",
        "address": "string",
        "city": "string",
        "neighborhood": "string",
        "isRented": true,
        "builtArea": 0,
        "lotArea": 0,
        "levels": 0,
        "propertyType": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "hasInventories": true,
        "createdAt": "2026-02-06T18:36:21.556Z",
        "modifiedAt": "2026-02-06T18:36:21.556Z"
      }
    ],
    "page": 0,
    "pageSize": 0,
    "totalRecords": 0,
    "totalPages": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Detail of a property

GET /v1/property/details

Query Parameters

Name
Type
Description

PropertyId*

uuid

Unique id of property

Response

circle-exclamation
circle-info

In the response for listing of all properties with information pagination, return the newOffset attribute, with this new value, can paginated the next properties. if the newOffset attribute is -1, is the last request can do to get data.

Last updated