ZUzuper

Get Assets By Generic Filter

Changed on

Rule-engine-based list endpoint — an alternative to the simple filter.* query params on Get All Assets, for building complex AND/OR filter conditions.

post/assets/filter

Request

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

Query parameters

pageinteger required
limitinteger required
sort'ASC' | 'DESC' required
sort_by'asset_code' | 'asset_name' | 'asset_serial_number' | 'purchase_date' | 'placed_in_service' | 'warranty_expiry_date' | 'created_at' | 'updated_at' required

Request body

Response

200

typestring
total_recordsinteger
total_pagesinteger
current_pageinteger

Example response

{
  "type": "success",
  "data": [
    {
      "customer": {
        "customer_uid": "988d1e50-63e1-11ed-b940-1743c554f5b8",
        "customer_first_name": "Valliyappan Test",
        "customer_last_name": "Customer",
        "customer_organization": {
          "is_active": true,
          "organization_address": {
            "street": "Prakasam Street Gangai Karai Puram ",
            "landmark": "test",
            "city": "Chennai ",
            "zip_code": "600017",
            "geo_cordinates": [
              13.0494011
            ],
            "state": "Tamil Nadu ",
            "country": "India"
          },
          "organization_name": "Organization B",
          "organization_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/e3b71910-622d-11eb-acfd-7fcb0a8f1c32.png",
          "organization_email": "test@zuper.co",
          "organization_uid": "32d0e260-622e-11eb-acfd-7fcb0a8f1c32"
        },
        "customer_email": "valliyappan.59@gmail.com",
        "customer_contact_no": {
          "mobile": "+919600086457",
          "home": "+919600086457",
          "work": "+919600086457"
        },
        "is_active": true
      },
      "asset_code": "EG01",
      "asset_name": "Asset #1",
      "asset_quantity": 1,
      "placed_in_service": "2019-11-26T18:30:00.000Z",
      "asset_uid": "a66b2660-02ce-11ea-9b9c-3396bbcbc13d",
      "created_by": {
        "user_uid": "71468f36-a847-49a6-b849-02b6992b2b08",
        "first_name": "Simon",
        "last_name": "V",
        "email": "sreevidya@zuper.co",
        "home_phone_number": "7010092903",
        "designation": "Admin",
        "emp_code": "120",
        "work_phone_number": "7010092903",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/6024fd20-080c-11ed-be73-8b6ed5c86b4b.jpg",
        "hourly_labor_charge": 120,
        "is_active": true,
        "created_at": "2019-01-21T07:24:22.000Z",
        "updated_at": "2023-10-05T11:24:19.000Z"
      },
      "updated_at": "2023-10-11T10:51:21.534Z",
      "created_at": "2019-11-09T08:55:16.680Z",
      "is_active": true,
      "asset_location": {
        "city": "Chennai",
        "state": "Tamil Nadu",
        "street": "No.49, G2, Ranga Vilas, CTS Apartments, 2nd Street, Bhuvaneshwari Nagar, Adambakkam,",
        "country": "India",
        "zip_code": "600099",
        "first_name": "Valliyappan Test",
        "last_name": "Customer",
        "phone_number": "+919600086457",
        "email": "valliyappan.59@gmail.com"
      },
      "custom_fields": [
        {
          "label": "Text Input",
          "type": "SINGLE_LINE",
          "_id": "651d0fefba147c8fe77ff4bc"
        }
      ],
      "warranty_expiry_date": "2024-12-24T18:29:00.000Z",
      "asset_status": "UNDER_SERVICE",
      "asset_category": {
        "category_name": "TEST",
        "category_description": "test",
        "category_uid": "48d3c590-859d-11eb-a715-479656013538"
      },
      "purchase_date": "2023-01-08T18:30:00.000Z",
      "organization": {
        "organization_address": {
          "street": "Prakasam Street Gangai Karai Puram ",
          "landmark": "test",
          "city": "Chennai ",
          "zip_code": "600017",
          "geo_cordinates": [
            13.0494011
          ],
          "state": "Tamil Nadu ",
          "country": "India"
        },
        "organization_name": "Organization B",
        "organization_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/e3b71910-622d-11eb-acfd-7fcb0a8f1c32.png",
        "organization_email": "test@zuper.co",
        "organization_uid": "32d0e260-622e-11eb-acfd-7fcb0a8f1c32",
        "no_of_customers": 7
      },
      "id": "undefined"
    }
  ],
  "total_records": 799,
  "total_pages": 80,
  "current_page": 1
}

Changes