latestOpenAPI 3.0.02026-08-1284111344.5 KB
14666f4db0f8
Jobs
Retrieve a list of Jobs
Retrieves a paginated list of Jobs, optionally filtered by date range.
get/v2/jobs
Query parameters
pageSizenumber
Example:10
Number of records to return per page.
pagenumber
Example:1
The page index.
field'created' | 'updated' | 'statusUpdated' | 'utcUpdated'
The field to sort results by. Must be combined with order.
order'ASC' | 'DESC'
The sort direction. Must be combined with field.
isOpenboolean
Example:true
When true, returns only open jobs.
dateProperty'date' | 'endDate' | 'utcUpdated' | 'created'
The job date field to apply the date filter to. Must be combined with dateOperator and date.
dateOperator'prev' | 'next' | 'between'
Comparison operator for the date filter. Must be combined with dateProperty and date.
datestring
Date value(s) for the filter. Format depends on dateOperator: prev / next accept a single date (YYYY-MM-DD); between accepts two dates separated by _ (YYYY-MM-DD_YYYY-MM-DD).
Headers
Authorizationstring required
Example:Bearer <token>
Bearer Token
Response
A paginated list of Jobs.
Example response
{
"pageSize": 10,
"page": 1,
"totalResults": 50,
"hasMore": true,
"data": [
{
"id": "JOB-BA5r7o4bqzR9MONa",
"uuid": "3YBIBO",
"serialId": 12345,
"name": "AC Repair",
"status": "Submitted",
"subStatus": {
"id": "JSS-BA5r7o4bqzR9MONa",
"name": "Follow Up"
},
"date": "2022-01-01 10:00:00",
"endDate": "2022-01-01 10:00:00",
"isScheduled": true,
"jobType": {
"id": "JT-8718036049ec4c4d",
"name": "Repair"
},
"adGroup": {
"id": "AG-71b8d7310acbf8cc",
"name": "Ad Group 1"
},
"description": "This is a description of the job.",
"subTotal": 946,
"discountAmount": 10,
"taxableAmount": 946,
"taxPercent": 10.111,
"taxAmount": 10.51,
"costing": 10.51,
"techExpenses": 12.51,
"tipAmount": 43.51,
"totalPrice": 956.51,
"amountDue": 956.51,
"amountDueDate": "2022-01-01 10:00:00",
"converted": true,
"clientInfo": {
"clientId": "CL-OvmDp2yvv1yqMwRl",
"serialId": 1023,
"firstName": "John Doe",
"lastName": "Doe",
"companyName": "Sample Company name",
"email": "client@workiz.com",
"primaryExt": "619",
"primaryPhone": "6195555555",
"secondaryExt": "613",
"secondaryPhone": "6195555555",
"addressDetails": {
"country": "US",
"state": "Ohio",
"city": "San Francisco",
"zipCode": "94102",
"address": "462 Powell St",
"unit": "3422",
"latitude": -76.2768398,
"longitude": 36.9669587,
"locationKey": "462 Powell St, San Francisco, Ohio 94102"
},
"serviceArea": {
"id": "SA-71b8d7310acbf8cc",
"name": "San Francisco"
}
},
"maskedNumber": {
"number": "6195551234",
"extension": "042",
"secondaryExtension": "043"
},
"team": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "John Doe"
}
],
"lineItems": [
{
"id": "JLI-BA5r7o4bqzR9MONa",
"productId": 1000,
"type": "product",
"name": "Deadbolt",
"description": "Deadbolt replacement, any color and size",
"price": 100,
"quantity": 1,
"total": 100,
"cost": 100,
"taxable": true,
"discountable": true,
"inventoryManaged": true,
"inventorySync": true,
"optionalConverted": true
}
],
"payments": [
{
"id": "PAY-BA5r7o4bqzR9MONa",
"type": "Cash",
"amount": 100,
"tipAmount": 10
}
],
"tags": [
{
"id": "TAG-8cddc18e7b0458fa",
"name": "Estimate"
}
],
"customFields": [
{
"id": "CF-eYLPK7198xVp6Z8q",
"fieldName": "Custom Field 1",
"value": "John Doe"
}
],
"notes": [
{
"id": "JNT-8cddc18e7b0458fa",
"techName": "John Doe",
"note": "This is a note",
"timestamp": "2022-01-01 10:00:00"
}
],
"conversionDate": "2022-01-01 10:00:00",
"statusUpdated": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00",
"createdAt": "2022-01-01 10:00:00"
}
]
}