ZUzuper

Get Dispatch Board Jobs

Changed on
get/jobs/dispatch_board

Request

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

Query parameters

pageinteger
countinteger
sort'"ASC"' | '"DESC"'
sort_by''
date_type''
populate_routeboolean
timezonestring
type''UNASSIGNED'' | ''ASSIGNED'' | ''UNSCHEDULED'' | ''OVERDUE'' | ''ALL''
filter.job_categorystring[]
filter.statusstring
filter.keywordstring
filter.customerstring[]
filter.prioritystring
filter.job_tagsstring[]
filter.created_atstring
filter.created_bystring[]
filter.custom_fieldstring[]
filter.assetstring[]
filter.ppmstring[]
filter.service_contractstring[]
filter.job_uidstring[]
filter.customer_feedbackstring
filter.recurrence_job_uidstring[]
filter.is_recurrenceboolean
filter.job_typestring
filter.scheduledstring
filter.propertystring[]
filter.customer_organizationstring
filter.created_at_fromstring
filter.created_at_tostring
filter.from_datestring
filter.to_datestring
filter.due_date_fromstring
filter.due_date_tostring
filter.service_territorystring[]
filter.skillset_uidstring[]
filter.projectstring[]

Response

200

typestring

Example response

{
  "data": {
    "unassigned_jobs": {
      "data": [
        {
          "job_uid": "b235871b-4ba5-4275-ab72-3e3fdbdcd075",
          "customer": {
            "customer_uid": "394c44e7-089c-4f4d-8f8e-5eed1f8822e0",
            "customer_first_name": "Tom",
            "customer_last_name": "cruse",
            "customer_organization": {
              "organization_uid": "74590dc0-371d-4a19-b1ed-17d0a5c556ea",
              "organization_name": "Test",
              "organization_address": {
                "city": "Chennai ",
                "state": "Tamil Nadu ",
                "street": "Chennai International Airport (MAA), Airport Road, Meenambakkam",
                "country": "India",
                "zip_code": "600027",
                "geo_cordinates": [
                  12.9811068
                ]
              },
              "is_active": true
            },
            "customer_email": "sda@sd.com",
            "customer_contact_no": {
              "mobile": "321321312312",
              "home": "2132132121321",
              "work": "3123123123123"
            },
            "is_active": true
          },
          "organization": {
            "organization_uid": "74590dc0-371d-4a19-b1ed-17d0a5c556ea",
            "organization_name": "Test",
            "no_of_customers": 3,
            "organization_address": {
              "city": "Chennai ",
              "state": "Tamil Nadu ",
              "street": "Chennai International Airport (MAA), Airport Road, Meenambakkam",
              "country": "India",
              "zip_code": "600027",
              "geo_cordinates": [
                12.9811068
              ]
            },
            "organization_billing_address": {
              "city": "Chennai ",
              "state": "Tamil Nadu ",
              "street": "Chennai International Airport (MAA), Airport Road, Meenambakkam",
              "country": "India",
              "zip_code": "600027",
              "geo_cordinates": [
                12.9811068
              ]
            },
            "is_active": true,
            "created_at": "2024-06-14T07:55:11.896Z",
            "updated_at": "2024-06-14T07:55:11.898Z"
          },
          "job_title": "s",
          "job_category": {
            "category_uid": "d1da5619-2917-4508-8adc-d37b0c699a93",
            "category_name": "test",
            "category_color": "#3498db",
            "estimated_duration": {
              "days": 2
            }
          },
          "job_priority": "LOW",
          "scheduled_start_time": "2024-09-18T03:00:00.000Z",
          "scheduled_end_time": "2024-09-18T04:00:00.000Z",
          "scheduled_duration": 2940,
          "customer_address": {
            "city": "Chennai ",
            "state": "Tamil Nadu ",
            "street": "Chennai International Airport (MAA), Airport Road, Meenambakkam",
            "country": "India",
            "zip_code": "600027",
            "first_name": "Tom",
            "last_name": "cruse",
            "phone_number": "321321312312",
            "email": "sda@sd.com",
            "geo_cordinates": [
              12.9811068
            ],
            "point_coordinates": {
              "type": "Point",
              "coordinates": [
                80.159623
              ]
            }
          },
          "customer_billing_address": {
            "city": "Chennai ",
            "state": "Tamil Nadu ",
            "street": "Chennai International Airport (MAA), Airport Road, Meenambakkam",
            "country": "India",
            "zip_code": "600027",
            "first_name": "Tom",
            "last_name": "cruse",
            "phone_number": "321321312312",
            "email": "sda@sd.com",
            "geo_cordinates": [
              12.9811068
            ],
            "point_coordinates": {
              "type": "Point",
              "coordinates": [
                80.159623
              ]
            }
          },
          "created_by": {
            "user_uid": "b9c91ee7-850f-47b7-b2cd-a6b78f4254d3",
            "first_name": "Tom",
            "last_name": "R",
            "email": "tom.r@abc.co",
            "designation": "Admin",
            "emp_code": "001",
            "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.abc/attachments/4ddf323f-19ed-4b56-81cc-70d0bdf628c5/ea2602d9-0379-4ffb-a2c0-916dc2558c56.JPG",
            "is_active": true,
            "created_at": "2024-06-14T07:34:28.000Z",
            "updated_at": "2024-09-18T04:03:31.000Z",
            "role": {
              "role_id": 1,
              "role_uid": "504e4eac-ff7d-11e7-8be5-0ed5f89f718b",
              "role_name": "Admin",
              "role_key": "ADMIN",
              "created_at": "2018-01-22T00:00:00.000Z",
              "updated_at": "2018-01-22T00:00:00.000Z"
            }
          },
          "created_at": "2024-09-18T07:10:47.422Z",
          "work_order_number": 268,
          "id": "undefined"
        }
      ],
      "total_records": 5,
      "current_page": 1,
      "total_pages": 1
    },
    "assigned_jobs": {
      "current_page": 1,
      "total_pages": 1
    },
    "unscheduled_jobs": {
      "current_page": 1,
      "total_pages": 1
    },
    "overdue_jobs": {
      "current_page": 1,
      "total_pages": 1
    }
  },
  "type": "success"
}

Changes