v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get All Properties

get/property

Query parameters

pageinteger

limitinteger

filter.keywordstring

filter.property_uidstring

Multiple values are supported with a delimiter ','

filter.organizationstring

Multiple values are supported with a delimiter ','

filter.cusotmerstring

Multiple values are supported with a delimiter ','

filter.parent_propertystring

Multiple values are supported with a delimiter ','

filter.assigned_tostring

Multiple values are supported with a delimiter ','

filter.created_bystring

Multiple values are supported with a delimiter ','

filter.created_at_fromstring date

filter.created_at_tostring date

filter.no_of_jobs_frominteger

filter.no_of_jobs_tointeger

filter.custom_fieldstring

filter.is_activeboolean

filter.is_deletedboolean

Response

200

typestring

current_page_recordsinteger

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "property_uid": "99b76887-e31d-47bd-9e30-16ad17ba0db9",
      "property_name": "Property One",
      "property_address": {
        "city": "Jacquelynfield",
        "state": "South Carolina",
        "street": "Wiza Trafficway",
        "country": "Morocco",
        "landmark": "quos",
        "zip_code": "80795",
        "geo_cordinates": [
          87.5701
        ]
      },
      "custom_fields": [
        {
          "label": "PCF_1",
          "value": "Aut porro quo exercitationem impedit vel aut.",
          "type": "SINGLE_LINE"
        }
      ],
      "is_active": true,
      "created_by": {
        "user_uid": "3b01e998-8c9a-459f-95cd-f557e7cf3c49",
        "first_name": "Valliyappan",
        "last_name": "S",
        "email": "valliyappan.s@zuper.co",
        "home_phone_number": "9600086457",
        "designation": "Admin",
        "emp_code": "001",
        "work_phone_number": "9600086457",
        "is_active": true,
        "role": {
          "role_id": 1,
          "role_uid": "d0169b01-79c1-4262-9231-a386f2df16c3",
          "role_name": "Admin",
          "role_key": "ADMIN",
          "created_at": "2022-09-22T13:14:28.000Z",
          "updated_at": "2022-09-22T13:14:28.000Z"
        }
      },
      "created_at": "2023-10-02T07:25:00.220Z",
      "updated_at": "2023-10-02T07:25:00.225Z"
    }
  ],
  "current_page_records": 10,
  "total_records": 10,
  "current_page": 2,
  "total_pages": 5
}