v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get Requests

get/request

Query parameters

pageinteger

limitinteger

sort'DESC' | 'ASC'

sort_by'created_at'

filter.keywordstring

For search

filter.request_priority'LOW' | 'MEDIUM' | 'HIGH' | 'URGENT'

filter.request_statusstring

request status uids

filter.customerstring

customer uids

filter.organizationstring

organization uids

filter.propertystring

property uids

filter.assetstring

asset uids

filter.created_at_fromstring date

created at from date

filter.created_at_tostring date

created at to date

filter.due_date_fromstring date

due date from

filter.due_date_tostring date

due date to

filter.preferred_date_fromstring date

preferred_date_from

filter.preferred_date_tostring date

preferred_date_to

filter.updated_at_fromstring date

updated_at_from

filter.updated_at_tostring date

updated_at_to

filter.assigned'ASSIGNED' | 'UNASSIGNED'

filter.assigned_tostring

user uids

filter.assigned_to_teamstring

team uids

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "request_uid": "e8836fa0-78ac-11ee-9d12-6dfb540878cd",
      "request_title": "testRequestService05",
      "request_description": "testing Request Service",
      "request_priority": "MEDIUM",
      "request_due_date": "2022-12-12T00:10:00.000Z",
      "request_preferred_date1": {
        "start_time": "2022-12-12T00:10:00.000Z",
        "end_time": "2022-12-12T20:10:00.000Z"
      },
      "request_preferred_date2": "2022-12-12T00:10:00.000Z",
      "customer": {
        "customer_uid": "c6d65b80-5f51-11ed-a1fa-8d475f25e205",
        "customer_first_name": "Testcustomer",
        "customer_email": "velmurugan.k@zuper.co",
        "is_active": true
      },
      "organization": {
        "organization_name": "Test org",
        "organization_email": "richard.mathew@gmail.com"
      },
      "service_address": {
        "landmark": "tst",
        "city": "tst",
        "state": "tst",
        "street": "tst",
        "country": "tst",
        "zip_code": "tst",
        "first_name": "tst",
        "last_name": "tst",
        "phone_number": "tst",
        "email": "tst"
      },
      "billing_address": {
        "landmark": "tst",
        "city": "tst",
        "state": "tst",
        "street": "tst",
        "country": "tst",
        "zip_code": "tst",
        "first_name": "tst",
        "last_name": "tst",
        "phone_number": "tst",
        "email": "tst"
      },
      "request_status": {
        "created_at": "2023-11-01T11:50:53.539Z"
      },
      "assigned_to": [
        {
          "user": {
            "user_uid": "dee40152-bf45-463c-92c3-eb62804490e2",
            "first_name": "test",
            "last_name": "f5",
            "email": "velu.k@zuper.co",
            "designation": "FE",
            "emp_code": "FE5",
            "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
            "is_active": true,
            "created_at": "2022-12-01T13:19:24.000Z",
            "updated_at": "2022-12-01T13:19:24.000Z",
            "role": {
              "role_id": 3,
              "role_uid": "37a7b7c4-e261-408e-9c7b-de6d784735c6",
              "role_name": "Field Executive",
              "role_key": "FIELD_EXECUTIVE",
              "created_at": "2022-11-02T13:31:29.000Z",
              "updated_at": "2022-11-02T13:31:29.000Z"
            }
          },
          "team": {
            "team_uid": "4e1c409f-32fd-42fe-9be0-72f48e0467fa",
            "team_name": "Test Team 4",
            "team_color": "#4960a0",
            "is_active": true
          }
        }
      ],
      "created_by": {
        "user_uid": "cfa78be2-b427-4d5a-89fe-7cf4a8e01352",
        "first_name": "velmurugan",
        "last_name": "k",
        "email": "velmurugan.k@zuper.co",
        "home_phone_number": "9600086457",
        "designation": "Admin",
        "emp_code": "001",
        "work_phone_number": "9600086457",
        "hourly_labor_charge": 20,
        "is_active": true,
        "created_at": "2022-11-03T11:33:22.000Z",
        "updated_at": "2023-10-10T13:38:04.000Z",
        "role": {
          "role_id": 1,
          "role_uid": "83674ce3-58f7-4992-b126-2413ea72832d",
          "role_name": "Admin",
          "role_key": "ADMIN",
          "created_at": "2022-11-02T13:31:29.000Z",
          "updated_at": "2022-11-02T13:31:29.000Z"
        }
      },
      "created_at": "2023-11-01T11:50:53.539Z",
      "updated_at": "2023-11-01T11:55:18.308Z",
      "request_id": 29
    }
  ],
  "total_records": 1,
  "current_page": 1,
  "total_pages": 1
}