v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get Jobs

get/jobs

Query parameters

filter.prioritystring

Filter based On priority of the Job, Allowed:URGENT,HIGH,MEDIUM,LOW

filter.customerstring

Filter based on customer using customer UIDs

filter.categorystring

Filter based on category using category UIDs

filter.keywordstring

Used for search

filter.job_tagsstring

Filter on job tags

filter.job_statusstring

Filter based on job status

filter.from_datestring

Filter based on job schduled from date

filter.to_datestring

Filter based on job scheduled to date

filter.updated_atstring

Filter based on job updated at date

filter.updated_at_fromstring

Filter based on job updated at from

filter.updated_at_tostring

Filter based on job updated at to

filter.assigned_tostring

Filter based on assigned users on job

filter.assigned_to_teamstring

Filter based on assigned teams on job

filter.created_bystring

Filter based on created by date

filter.custom_fieldstring

Filter based on custom field

filter.assetstring

Filter based on asset using asset UIDs

filter.ppmstring

Filter based on ppm uising ppm UIDs

filter.service_contractstring

Filter based on service contract using service contract UIDs

filter.job_uidstring

Filter based on job UIDS

filter.customer_feedbackstring

Filter based on customer feedback, Allowed: 'HAPPY', 'NEUTRAL', 'UNHAPPY', 'VERY_HAPPY', 'VERY_UNHAPPY'

filter.recurrence_job_uidstring

Filter based on recurrence job UIDs

filter.is_recurrencestring

Filter recurrence job

filter.job_typestring

Filter based on job type. Allowed: 'NEW', 'REVISIT'

filter.due_date_fromstring

Filter based on job due date

filter.due_date_tostring

Filter based on job due date

filter.scheduledstring

Filter based on scheduled date

filter.propertystring

Filter based on property using Property UIDs

filter.customer_organizationstring

Filter based on organisation using organization UIDs

filter.created_atstring

Filter based on job created at date

filter.created_at_fromstring

Filter based on job created at from date

filter.created_at_tostring

Filter based on job created at to date

filter.status_in_historystring

Filter based on status

filter.routestring

Filter based on job route

filter.parent_jobstring

Filter based on parent job using JOB UIDs

filter.is_deletedstring

Filter Deleted jobs max of 90 days

filter.work_order_numberstring

Filter based on job work order number

filter.has_routestring

Filter based on route enabled for job

filter.delayed_jobstring

Filter based on delayed job

filter.is_invoicedstring

Filter based on invoiced jobs

filter.invoice_statusstring

Filter based on invoice status jobs

filter.assignedstring

filter.service_territorystring

filter.projectstring

filter.request_uidstring

filter.business_unitstring

statusstring

Filter based on Job status

pagestring

Page number

countstring

Maximum allowed 1000

sortstring

Allowed Keys: DESC, ASC

sort_bystring

Allowed Keys: work_order_number, job_priority, scheduled_start_time, due_date

date_typestring

Allowed Keys: scheduled_date, created_date, current_status_updated_at

Headers

authorizationstring

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "job_uid": "698d5560-6e3b-11ee-9637-5d3ccadf022e",
      "organization": {
        "organization_uid": "ca32ebd0-9c8d-11ed-9f13-9789cec5f4f1",
        "organization_name": "2503nithintest",
        "organization_email": "2503nithin@mail.com",
        "organization_address": {
          "city": "Chennai ",
          "state": "Tamil Nadu ",
          "street": "Chennai ",
          "country": "India",
          "geo_cordinates": [
            13.0834622272901
          ]
        },
        "is_active": true
      },
      "prefix": "Q3_0001",
      "job_title": "test job",
      "job_category": {
        "estimated_duration": {
          "days": 2
        },
        "category_color": "#000",
        "category_name": "Recurring",
        "category_uid": "24b49530-37dc-11ec-9f98-2573cda9e3a6"
      },
      "job_priority": "LOW",
      "job_type": "NEW",
      "due_date": "2023-10-19T18:29:00.000Z",
      "current_job_status": {
        "status_uid": "f2fff4a7-1e27-406d-b091-5641ef59841b",
        "status_name": "test",
        "status_type": "NEW",
        "status_color": "#02B875"
      },
      "job_status": [
        {
          "status_uid": "f2fff4a7-1e27-406d-b091-5641ef59841b",
          "status_name": "test",
          "status_type": "NEW",
          "status_color": "#02B875",
          "created_at": "2023-10-19T04:53:14.991Z",
          "synced_at": "2023-10-19T04:53:14.991Z"
        }
      ],
      "customer_address": {
        "city": "Chennai ",
        "state": "Tamil Nadu ",
        "street": "Chennai ",
        "country": "India",
        "geo_cordinates": [
          13.0834622272901
        ],
        "first_name": "2503nithintest",
        "email": "2503nithin@mail.com"
      },
      "customer_billing_address": {
        "city": "Chennai ",
        "state": "Tamil Nadu ",
        "street": "Chennai ",
        "country": "India",
        "geo_cordinates": [
          13.0834622272901
        ],
        "first_name": "2503nithintest",
        "email": "2503nithin@mail.com"
      },
      "custom_fields": [
        {
          "label": "Job Feedback",
          "type": "SINGLE_LINE",
          "_id": "6530b63a0d8d103406ac12f1"
        }
      ],
      "created_by": {
        "user_uid": "297ff853-597b-4f24-a738-b24b4e4a41cf",
        "first_name": "Jegadheesh",
        "last_name": "R",
        "email": "jegadheesh.r@zuper.co",
        "designation": "Admin",
        "emp_code": "1234",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
        "hourly_labor_charge": 20,
        "is_active": true,
        "created_at": "2023-09-26T10:13:03.000Z",
        "updated_at": "2023-09-26T10:13:03.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": "2023-10-19T04:53:14.996Z",
      "updated_at": "2023-10-19T04:53:15.168Z",
      "work_order_number": 13577
    }
  ],
  "total_records": 11503,
  "current_page": 1,
  "total_pages": 1151
}

All 383 operations