get/v2/customer_portal/assets

Request

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

Query parameters

pageinteger required
countinteger required
sort'DESC' | 'ASC' required
sort_by'created_at' | 'warranty_expiry_date' | 'asset_code' | 'next_service_date' required
timezonestring
filter.categorystring
filter.asset_status'READY_TO_INSTALL' | 'INSTALLED' | 'UNDER_SERVICE' | 'REMOVED' | 'OBSOLETE'
filter.warranty_from_datestring date
filter.warranty_to_datestring date
filter.keywordstring
filter.jobstring
filter.purchase_date_fromstring date
filter.purchase_date_tostring date
filter.next_service_date_fromstring date
filter.next_service_date_tostring date
filter.placed_in_service_fromstring date
filter.placed_in_service_tostring date
filter.propertystring
filter.organizationstring
filter.nearing_expiryboolean

Response

200

typestring
current_page_recordsinteger
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "asset_uid": "97c04e70-fbad-11ed-b804-e3a92abd251d",
      "asset_code": "T002",
      "asset_name": "Testing Product",
      "asset_image": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/0a2d5d70-05ec-11ee-a9c9-fb61d7de43f3.png",
      "asset_category": {
        "category_name": "Air Conditioner",
        "category_description": "Description",
        "category_uid": "22b74240-09fe-11ea-b1f3-d505ea8dd454"
      },
      "customer": {
        "customer_last_name": "Road1",
        "customer_first_name": "k",
        "customer_uid": "f87c5090-912b-11eb-83fb-0bb37ca0015c"
      },
      "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
      },
      "property": {
        "property_uid": "b08cacd0-aca6-11eb-8a0f-db67156a3299",
        "property_name": "Neon",
        "no_of_jobs": 3,
        "property_address": {
          "city": "Chennai ",
          "state": "Tamil Nadu ",
          "street": "Marina Beach ",
          "country": "India",
          "geo_cordinates": [
            13.0555796
          ],
          "_id": "640815c5c4a861b276c40cef",
          "point_coordinates": {
            "type": "Point",
            "coordinates": [
              80.2836996
            ]
          }
        }
      },
      "asset_status": "INSTALLED",
      "custom_fields": [
        {
          "label": "Text Input",
          "type": "SINGLE_LINE",
          "_id": "6481bba21b80a8e0947edf2f"
        }
      ],
      "asset_location": {
        "city": "Chennai ",
        "state": "Tamil Nadu ",
        "street": "Marina Beach ",
        "country": "India",
        "geo_cordinates": [
          13.0555796
        ],
        "first_name": "New Customer",
        "last_name": "S",
        "email": "sushil@zuper.co",
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.2836996
          ]
        }
      },
      "is_active": true,
      "created_at": "2023-05-26T10:10:51.321Z",
      "updated_at": "2023-06-23T09:51:54.023Z",
      "warranty_expiry_date": "2023-06-09T18:29:00.000Z",
      "purchase_date": "2023-06-07T18:30:00.000Z",
      "asset_barcode": "sample addd"
    }
  ],
  "current_page_records": 1,
  "total_records": 26,
  "current_page": 1,
  "total_pages": 26
}

Changes