Get Jobs
Changed onRequest
- Base URLhttps://dc-region.zuperpro.com/api
- URLhttps://dc-region.zuperpro.com/api/jobs
- AuthAPI key in header x-api-key
Query parameters
Filter based On priority of the Job, Allowed:URGENT,HIGH,MEDIUM,LOW
Filter based on customer using customer UIDs
Filter based on category using category UIDs
Used for search
Filter on job tags
Filter based on job status. Only the status uid works (not the status name) — sending a name like "New" returns 200 with 0 rows rather than resolving it or erroring. Get the uid from GET /jobs/status/{category_uid}.
Filter based on job schduled from date
Filter based on job scheduled to date
Filter based on job updated at date
Filter based on job updated at from. Requires a full timestamp in one of: YYYY-MM-DDTHH:mm:ssZ, YYYY-MM-DD HH:mm:ss, YYYY-MM-DDTHH:mm:ss.SSSZ, YYYY-MM-DD HH:mm:ss.SSS. A plain date (e.g. 2026-09-01) is rejected with 400 "Invalid Updated Date" — unlike filter.created_at_from/to, which accept a plain date. Both bounds must be sent together — sending only one silently applies no filter at all (not treated as an open-ended range), with no error.
Filter based on job updated at to. Both bounds must be sent together — sending only one silently applies no filter at all (not treated as an open-ended range), with no error.
Filter based on assigned users on job
Filter based on assigned teams on job
Filter based on created by date
Filter based on custom field. Expects JSON: {"label": "<custom field label>", "value": "<value>"}. An optional third key, "is_regex": true, matches value as a case-insensitive regex instead of exact equality (undocumented elsewhere). A non-JSON string returns 400 "Invalid Format"; valid JSON with different keys (e.g. field_name/field_value) returns 200 with 0 rows rather than an error.
Filter based on asset using asset UIDs
Filter based on ppm uising ppm UIDs
Filter based on service contract using service contract UIDs
Filter based on job UIDS
Filter based on customer feedback, Allowed: 'HAPPY', 'NEUTRAL', 'UNHAPPY', 'VERY_HAPPY', 'VERY_UNHAPPY'
Filter based on recurrence job UIDs
Filter recurrence job
Filter based on job type. Allowed: 'NEW', 'REVISIT'
Filter based on job due date
Filter based on job due date
Filter based on scheduled date
Filter based on property using Property UIDs
Filter based on organisation using organization UIDs
Filter based on job created at date
Filter based on job created at from date. Accepts a plain YYYY-MM-DD date (expanded to 00:00:00/23:59:59 in the company's timezone) — unlike filter.updated_at_from/to, which require a full timestamp. Both bounds must be sent together — sending only one silently applies no filter at all (not treated as an open-ended range), with no error.
Filter based on job created at to date. Both bounds must be sent together — sending only one silently applies no filter at all (not treated as an open-ended range), with no error.
Filter based on status
Filter based on job route
Filter based on parent job using JOB UIDs
Filter Deleted jobs max of 90 days
Filter based on job work order number
Filter based on route enabled for job
Filter based on delayed job
Filter based on invoiced jobs
Filter based on invoice status jobs
Filter based on Job status
Page number
Maximum allowed 1000
Allowed Keys: DESC, ASC
Allowed Keys: work_order_number, job_priority, scheduled_start_time, due_date Note: created_at is NOT one of the allowed keys here, despite being a common first guess — sending it returns 400 "Invalid Sort By Value".
Allowed Keys: scheduled_date, created_date, current_status_updated_at
Headers
Response
200
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
}Changes
- info
added the optional property
//to the response with the status
- info