ZUzuper

Get Request Details

Changed on

This endpoint belongs to the separate Customer Portal service (the end-customer self-service portal), not the main company API. It requires a Customer Portal session bearer token, obtained when an end customer logs into their own portal — your company x-api-key will not work here and will return 401 "Unauthenticated Request". If you're building a company-side integration, use the company API's own Create/Get Request endpoints instead (see "Create Request" and "Get Request Details" under the main Requests section, which do accept x-api-key).

get/v2/customer_portal/request/{request_uid}

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/v2/customer_portal/request/{request_uid}
  • Auth
    HTTP bearer

Path parameters

request_uidstring required

Response

200

typestring

Example response

{
  "type": "success",
  "data": {
    "request_uid": "4fca8a96-f319-4cb7-b07d-981876e77819",
    "request_title": "test service 9",
    "request_description": "<p>resat</p>",
    "request_preferred_date1": {
      "start_time": "2024-10-01T07:00:00.000Z",
      "end_time": "2024-10-01T18:00:00.000Z",
      "_id": "66f91036bb52096e3df5e413"
    },
    "request_preferred_date2": {
      "start_time": "2024-10-03T07:00:00.000Z",
      "end_time": "2024-10-03T18:00:00.000Z",
      "_id": "66f91036bb52096e3df5e414"
    },
    "customer": {
      "customer_uid": "3b9a2a60-3d5f-11ed-a77f-7d639323b89a",
      "customer_first_name": "Ashin",
      "customer_last_name": "customer OG",
      "customer_email": "ashinthankachan1999@gmail.com",
      "customer_contact_no": {
        "mobile": "8301907278",
        "home": "123123",
        "work": "8301907278"
      },
      "customer_address": {
        "city": "Thoraipakkam ",
        "state": "Tamil Nadu ",
        "street": "Jain College, D B Jain College main enterence, Jothi Nagar",
        "country": "India",
        "landmark": "near jain college",
        "zip_code": "600097",
        "first_name": "Ashin",
        "last_name": "customer",
        "phone_number": "8301907278",
        "email": "ashinthankachan1999@gmail.com",
        "geo_cordinates": [
          12.9469543
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.2400814
          ]
        }
      },
      "is_active": true
    },
    "organization": {
      "organization_uid": "bd0a62d0-6cbc-11ee-83ad-4531910aaa26",
      "organization_name": "org17test2",
      "organization_email": "org17test2@mail.com",
      "is_active": true
    },
    "property": {
      "property_uid": "a32c1636-0ccb-47ed-8e8f-7ff02fcdd065",
      "property_name": "tst asdfinasd123",
      "property_address": {
        "city": "SAMMAMISH",
        "state": "Washington",
        "street": "24754 NE 3RD PL",
        "country": "test",
        "landmark": "test",
        "zip_code": "98074",
        "first_name": "test",
        "last_name": "test",
        "phone_number": "131242342",
        "email": "test@gmail.com",
        "_id": "66f90a4927283fab7aa80eb2"
      },
      "is_active": true
    },
    "service_contract": {
      "prefix": "Q1",
      "contract_uid": "ad08d8a5-5147-4f4e-9837-e9631dc6cc25",
      "contract_name": "CFM Basic",
      "billing_address": {
        "landmark": "near jain college",
        "city": "Thoraipakkam ",
        "state": "Tamil Nadu ",
        "street": "Jain College, D B Jain College main enterence, Jothi Nagar",
        "geo_cordinates": [
          12.9469543
        ],
        "first_name": "Ashin",
        "last_name": "customer",
        "phone_number": "8301907278",
        "email": "ashinthankachan1999@gmail.com"
      },
      "is_active": true,
      "contract_number": 1165
    },
    "service_address": {
      "landmark": "test",
      "city": "SAMMAMISH",
      "state": "Washington",
      "street": "24754 NE 3RD PL",
      "country": "test",
      "zip_code": "98074",
      "_id": "66f91036bb52096e3df5e415"
    },
    "billing_address": {
      "landmark": "test",
      "city": "SAMMAMISH",
      "state": "Washington",
      "street": "24754 NE 3RD PL",
      "country": "test",
      "zip_code": "98074",
      "_id": "66f91036bb52096e3df5e416"
    },
    "request_service": {
      "service_uid": "7be1334a-5101-4d41-abea-d4130d4280b4",
      "service_name": "Test service",
      "service_description": "Test service",
      "estimated_price": 5,
      "is_active": true
    },
    "request_status": {
      "status_type": "CANCELED",
      "status_color": "#e67e22",
      "status_uid": "2caf8549-21cf-484a-b79a-a615ae0a5e71",
      "status_name": "CANCELED",
      "_id": "66f911cb27283fab7aa80f2e"
    },
    "status_history": [
      {
        "status_uid": "26d89664-72c0-4280-b9fb-e9f4b38f8143",
        "status_color": "#3498db",
        "status_type": "OPEN",
        "status_name": "New Request",
        "_id": "66f91036bb52096e3df5e418",
        "created_at": "2024-09-29T08:30:46.972Z"
      }
    ],
    "attachments": [
      {
        "attachment_uid": "3af1d86f-d992-48d9-90a1-6493856c3f74",
        "file_name": "Screenshot from 2024-09-16 13-30-03.png",
        "url": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/f2941db1-8c41-4729-86fb-cdb8405f0a14.png",
        "visible_to_customer": true,
        "created_by_type": "CUSTOMER",
        "_id": "66f91036bb52096e3df5e419",
        "created_at": "2024-09-29T08:30:46.974Z"
      }
    ],
    "created_at": "2024-09-29T08:30:46.975Z",
    "updated_at": "2024-09-29T08:37:31.500Z",
    "request_id": 564
  }
}

Changes