ZUzuper

Get Customer Jobs

Changed on
get/v2/customer_portal/jobs/

Request

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

Query parameters

pageinteger required
countinteger
sort'DESC' | 'ASC'
sort_by'work_order_number' | 'job_priority' | 'scheduled_start_time' | 'due_date' | 'created_at'
filter.categorystring
filter.service_contractstring
filter.assetstring
filter.propertystring
filter.scheduled_date_fromstring date
filter.scheduled_date_tostring date
filter.due_date_fromstring date
filter.due_date_tostring date
filter.current_job_statusstring
filter.keywordstring

Response

200

typestring
current_page_recordsinteger
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "job_uid": "e26dd890-313e-4dd5-b3e5-5b7f2ea0302e",
      "customer": {
        "customer_uid": "3b9a2a60-3d5f-11ed-a77f-7d639323b89a",
        "customer_first_name": "Ashin",
        "customer_last_name": "customer OG"
      },
      "organization": {
        "organization_uid": "bd0a62d0-6cbc-11ee-83ad-4531910aaa26",
        "organization_name": "org17test2"
      },
      "assigned_to": [
        {
          "team_id": {
            "team_uid": "beeb0c3c-bb1b-4e5d-90c1-b465f1a1ceb9",
            "team_name": "Team Android",
            "team_color": "#0c9b24",
            "is_active": 1
          },
          "user_id": {
            "user_uid": "fc384971-6178-4ba2-9b44-a739ff0ae590",
            "first_name": "Harish",
            "last_name": "G",
            "email": "harish.g@zuper.co",
            "designation": "Android Dev",
            "emp_code": "H123",
            "prefix": "Z22",
            "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
            "hourly_labor_charge": 20,
            "is_active": 1,
            "created_at": "2024-07-15T12:26:41.000Z",
            "updated_at": "2024-07-23T13:49:30.000Z"
          },
          "acceptance_status": "AWAIT_RESPONSE",
          "_id": "66f3b65e05ddccb31b0fc39a",
          "assigned_at": "2024-09-25T07:06:06.081Z"
        }
      ],
      "job_title": "fsadfasdf",
      "job_category": {
        "category_color": "#e74c3c",
        "category_name": "Cleaning Service",
        "category_uid": "473ec140-058f-11ec-adaf-cbc38b630fba",
        "created_at": "2021-08-25T10:29:07.541Z",
        "updated_at": "2024-09-27T09:33:32.684Z"
      },
      "due_date": "2024-09-28T18:29:59.000Z",
      "current_job_status": {
        "status_uid": "b50ca8ab-ed17-45c2-a48a-80c4f828714a",
        "status_name": "New",
        "status_type": "NEW",
        "status_color": "#02B875"
      },
      "customer_address": {
        "city": "New York",
        "state": "New York",
        "street": "Library Hotel by Library Hotel Collection, East 41st Street",
        "zip_code": "10017",
        "geo_cordinates": [
          40.7521704
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            -73.9795322
          ]
        }
      },
      "customer_billing_address": {
        "city": "New York",
        "state": "New York",
        "street": "Library Hotel by Library Hotel Collection, East 41st Street",
        "zip_code": "10017",
        "geo_cordinates": [
          40.7521704
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            -73.9795322
          ]
        }
      },
      "custom_fields": [
        {
          "label": "Freshdesk ID",
          "type": "SINGLE_LINE",
          "_id": "66f3b65e05ddccb31b0fc39c"
        }
      ],
      "created_at": "2024-09-25T07:06:06.126Z",
      "updated_at": "2024-09-25T07:06:06.240Z",
      "work_order_number": 32441
    }
  ],
  "current_page_records": 1,
  "total_records": 286,
  "current_page": 1,
  "total_pages": 286
}

Changes