Get Job Schedule

Changed on
get/jobs/schedule

Request

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

Query parameters

from_datestring
to_datestring
date_typestring

Allowed keys: scheduled_date, created_date, current_status_updated_at

filter.team_uidstring[]
filter.job_categorystring[]
filter.prioritystring[]
filter.customerstring[]
filter.keywordstring
filter.job_tagsstring[]
filter.job_statusstring[]
filter.from_datestring
filter.to_datestring
filter.created_atstring
filter.updated_atstring
filter.updated_at_fromstring
filter.updated_at_tostring
statusstring[]
filter.assignedstring

Allowed keys: ASSIGNED, UNASSIGNED

filter.assigned_tostring[]
filter.assigned_to_teamstring[]
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.due_date_fromstring
filter.due_date_tostring
filter.scheduledstring
filter.propertystring[]
filter.customer_organizationstring[]
filter.created_at_fromstring
filter.created_at_tostring
filter.status_in_historystring[]
filter.routestring[]
filter.parent_jobstring[]
filter.is_deletedboolean
filter.work_order_numberstring[]
filter.has_routeboolean
filter.delayed_jobstring
filter.skillset_uidstring[]
filter.projectstring[]

Response

200

typestring

Example response

{
  "type": "success",
  "data": [
    {
      "job_uid": "bf69a808-14ad-4833-bef2-2c37a99154f1",
      "organization": {
        "organization_uid": "5658238f-daf9-4f52-b5d6-8856f731363f",
        "organization_name": "pacific",
        "is_active": true
      },
      "job_title": "re",
      "job_category": {
        "category_uid": "09c41e65-5669-4b06-99f9-bffbd6b246e0",
        "category_name": "assist",
        "category_color": "#000",
        "estimated_duration": {
          "hours": 1
        }
      },
      "job_priority": "LOW",
      "scheduled_start_time": "2024-09-03T03:00:00.000Z",
      "scheduled_end_time": "2024-09-03T04:00:00.000Z",
      "scheduled_duration": 60,
      "current_job_status": {
        "status_uid": "42e0bb65-6bd4-4bc4-b19f-a61c6e412910",
        "status_name": "New",
        "status_type": "NEW",
        "status_color": "#02B875"
      },
      "job_status": [
        {
          "status_uid": "42e0bb65-6bd4-4bc4-b19f-a61c6e412910",
          "status_name": "New",
          "status_type": "NEW",
          "status_color": "#02B875",
          "created_at": "2024-09-03T08:59:49.588Z",
          "synced_at": "2024-09-03T08:59:49.588Z"
        }
      ],
      "customer_address": {
        "city": "Chennai ",
        "state": "Tamil Nadu ",
        "street": "Chennai ",
        "country": "India",
        "first_name": "pacific",
        "geo_cordinates": [
          13.0843007
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.2704622
          ]
        }
      },
      "customer_billing_address": {
        "city": "Chennai ",
        "state": "Tamil Nadu ",
        "street": "Chennai ",
        "country": "India",
        "first_name": "pacific",
        "geo_cordinates": [
          13.0843007
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.2704622
          ]
        }
      },
      "is_recurrence": true,
      "created_by": {
        "user_uid": "b9c91ee7-850f-47b7-b2cd-a6b78f4254d3",
        "first_name": "Tom",
        "last_name": "R",
        "email": "tom.r@abc.co",
        "home_phone_number": "9999999999",
        "designation": "Admin",
        "emp_code": "001",
        "work_phone_number": "9999999999",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/4ddf323f-19ed-4b56-81cc-70d0df628c5/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"
      },
      "job_timezone": "Asia/Kolkata",
      "service_territory": {
        "is_conflict": true,
        "conflicts": [
          "NO_TERRITORY_FOUND"
        ]
      },
      "created_at": "2024-09-03T08:59:49.597Z",
      "work_order_number": 266
    }
  ]
}

Changes