ZUzuper

Get Property

Changed on
get/v2/customer_portal/property

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/v2/customer_portal/property
  • Auth
    API key in header x-api-key

Query parameters

pageinteger required
countinteger required
sort'DESC' | 'ASC'
created_at'created_at' | 'property_name'
filter.keywordstring

Response

200

typestring
current_page_recordsinteger
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "updated_at": "2024-04-25T08:48:07.721Z",
      "created_at": "2024-03-15T15:36:21.586Z",
      "is_active": true,
      "custom_fields": [
        {
          "label": "Property Reference Number",
          "type": "SINGLE_LINE",
          "_id": "65f800f04170562d80842d2e"
        }
      ],
      "property_address": {
        "city": "SAMMAMISH",
        "state": "Washington",
        "street": "24754 NE 3RD PL",
        "country": "United States",
        "zip_code": "98074",
        "_id": "65f800f04170562d80842d35"
      },
      "property_organization": {
        "organization_address": {
          "city": "San Marcos",
          "state": "Texas",
          "street": "Texas State University, University Drive",
          "zip_code": "78666",
          "geo_cordinates": [
            29.888411
          ],
          "first_name": "Org",
          "last_name": "SC",
          "phone_number": "8220131280",
          "email": "orgsc@abc.com",
          "point_coordinates": {
            "type": "Point",
            "coordinates": [
              -97.938351
            ]
          }
        },
        "organization_name": "Ascendas#",
        "organization_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/acb9ba40-8211-11eb-ab1f-1ddf213d24b4.jpg",
        "organization_email": "zupertest23@gmail.com",
        "organization_uid": "11d86a70-8212-11eb-ab1f-1ddf213d24b4",
        "no_of_customers": 43
      },
      "no_of_jobs": 1,
      "property_customers": [
        {
          "customer": {
            "customer_last_name": "Road1",
            "customer_billing_address": {
              "city": "Chennai",
              "state": "Tamil Nadu",
              "street": "35MF+FXP",
              "zip_code": "600037",
              "first_name": "0969 Ocean View",
              "last_name": "Road1",
              "email": "vignesh.s@zuper.co",
              "geo_cordinates": [
                13.0837224
              ],
              "point_coordinates": {
                "type": "Point",
                "coordinates": [
                  80.1749627
                ]
              }
            },
            "customer_address": {
              "city": "Chennai",
              "state": "Tamil Nadu",
              "street": "35MF+FXP",
              "zip_code": "600037",
              "first_name": "0969 Ocean View",
              "last_name": "Road1",
              "email": "vignesh.s@zuper.co",
              "geo_cordinates": [
                13.0837224
              ],
              "point_coordinates": {
                "type": "Point",
                "coordinates": [
                  80.1749627
                ]
              }
            },
            "customer_first_name": "k",
            "customer_uid": "f87c5090-912b-11eb-83fb-0bb37ca0015c"
          }
        }
      ],
      "property_name": "East Wing 1st Floor",
      "property_uid": "c6336500-e2e1-11ee-8fb7-110e4f8fb99a"
    }
  ],
  "current_page_records": 1,
  "total_records": 8,
  "current_page": 1,
  "total_pages": 8
}

Changes