developer notes
Get All Job Orders

The JobOrderGetAll API allows you to retrieve All existing Job Order records.
Method	API Endpoint
GET	`{{endpoint}}/api/ext/job-orders`
‍
Headers

‍
Key	Value
Content-Type	`application/json`
Authorization	`Bearer {{token}}`
‍
Filter Fields

‍
Parameter	Type	Example	Required	Description
`page`	Number	0	true	Specifies the page number
`perPage`	Number	25	true	Specifies the number of records per page
`startFrom`	Number	0	true	Specifies the start point of the column being sorted
`columnName`	String	id	true	Specifies the name of the column being sorted
`sortOrder`	String	desc/asc	true	Specifies the order in which the column is being sorted
`search`	String	a	true	Specifies the search query
`fromDate`	Date/Time	2023-10-05T02:15:13Z	false	Specifies the from date in search query
`toDate`	Date/Time	2023-10-05T03:15:13Z	false	Specifies the to date in search query
`customerId`	Number	2	false	Specifies the customer ID being filtered
`ticketId`	Number	1	false	Specifies the ticket ID being filtered
`assetId`	Number	2	false	Specifies the asset ID being filtered
`salesOrderId`	Number	3	false	Specifies the Sales Order ID being filtered
`status`	String	OPEN	false	Specifies the status of a task
`joTypeIds`	Number	2	false	Specifies the Job Order Type ID
`JobOrderTypeNames`	String	cext1	false	Specifies the Job Order Type Name
`systems`	***	***	false	System information for filtering
`serviceZoneId`	Number	1	false	Specifies the Service Zone ID
`faultId`	Number	12	false	Specifies the Fault ID
`fault`	String	Faulty Part	false	Specifies the Fault
`resolution`	String	Fixed On Site	false	Specifies the Resolution
`fetchOnlyOverDueJobOrders`	***	***	false	Specifies if only filtered for OverdueJobOrders
`roleId`	Number	3	false	Specifies the Role ID
`faultNotEmpty`	***	***	false	Specifies if only filtered for Job orders with a fault
`systemNotEmpty`	***	***	false	Specifies if only filtered for Job orders with a system
`siteId`	Number	1	false	Specifies the Site ID
`projectId`	Number	5	false	Specifies the Project ID
`pmvId`	Number	3	false	Specifies the PMV ID
`checklistRecordId`	Number	1	false	Specifies the Checklist Record ID
`origin`	String	a	false	Origin information for filtering
‍
API Query Example

‍
Method	API Call
GET	`api/ext/job-orders?origin=f&startFrom=0&perPage=25&columnName=id&sortOrder=asc&search=a&fromDate=&toDate&customerId=2&ticketId&assestId&salesOrderId&status&joTypeIds&jobOrderTypeNames&systems&serviceZoneId&faultId&fault&resolution&fetchOnlyOverDueJobOrders&roleId&faultNotEmpty&systemNotEmpty&siteId&projectId&pmvId&checkListRecordId`
‍
Example Response

‍
//status - 200
{
    "total": 33155,
    "count": 25,
    "data": [
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 1,
              "jobOrderNumber": "JO-000001",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
            "jobOrderProductList": null,
            "jobOrder": {
                "id": 2,
                "jobOrderNumber": "JO-000002",
                "jobOrderName": "Test",
                "installationDate": "2023-05-01",
                "installationTime": "2023-05-01T22:25:51Z",
                "status": "OPEN",
                "customer": {
                    "id": 3,
                    "name": "1 Load Test [DO NOT DELETE]",
                    "email": null,
                    "billingCity": null,
                    "billingCountry": null,
                    "billingPostcode": null,
                    "billingState": null,
                    "billingStreet": null,
                    "shippingCity": null,
                    "shippingCountry": null,
                    "shippingPostcode": null,
                    "shippingState": null,
                    "shippingStreet": null,
                    "contactPersonName": null,
                    "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 3,
              "jobOrderNumber": "JO-000003",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 4,
              "jobOrderNumber": "JO-000004",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 5,
              "jobOrderNumber": "JO-000005",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 6,
              "jobOrderNumber": "JO-000006",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 7,
              "jobOrderNumber": "JO-000007",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 8,
              "jobOrderNumber": "JO-000008",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 9,
              "jobOrderNumber": "JO-000009",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 10,
              "jobOrderNumber": "JO-000010",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 11,
              "jobOrderNumber": "JO-000011",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 64,
              "jobOrderNumber": "JO-000064",
              "jobOrderName": "Test",
              "installationDate": "2023-05-01",
              "installationTime": "2023-05-01T22:25:51Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 90,
              "jobOrderNumber": "JO-000090",
              "jobOrderName": "job order",
              "installationDate": "2023-05-11",
              "installationTime": "2023-05-11T23:00:17Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 91,
              "jobOrderNumber": "JO-000091",
              "jobOrderName": "test",
              "installationDate": "2023-05-11",
              "installationTime": "2023-05-11T23:23:06Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 116,
              "jobOrderNumber": "JO-000116",
              "jobOrderName": "Testing",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T08:39:05Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 119,
              "jobOrderNumber": "JO-000119",
              "jobOrderName": "Testing",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T08:39:05Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 121,
              "jobOrderNumber": "JO-000121",
              "jobOrderName": "Testing JO Load",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T09:53:21Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 122,
              "jobOrderNumber": "JO-000122",
              "jobOrderName": "Test Load JO - 2",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T09:55:36Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 124,
              "jobOrderNumber": "JO-000124",
              "jobOrderName": "Test Load JO - 2",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T09:55:36Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 126,
              "jobOrderNumber": "JO-000126",
              "jobOrderName": "Test Load JO - 2",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T09:55:36Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 129,
              "jobOrderNumber": "JO-000129",
              "jobOrderName": "Test Load JO - 2",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T09:55:36Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 131,
              "jobOrderNumber": "JO-000131",
              "jobOrderName": "Test Load JO - 2",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T09:55:36Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 134,
              "jobOrderNumber": "JO-000134",
              "jobOrderName": "Test Create JOO",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T03:47:03Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 138,
              "jobOrderNumber": "JO-000138",
              "jobOrderName": "tessssttttttt",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T14:49:33Z",
              "status": "OPEN",
              "customer": {
                  "id": 5,
                  "name": "Load Test",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        },
        {
          "jobOrderProductList": null,
          "jobOrder": {
              "id": 161,
              "jobOrderNumber": "JO-000161",
              "jobOrderName": "Test Create JOO",
              "installationDate": "2023-05-12",
              "installationTime": "2023-05-12T11:47:03Z",
              "status": "OPEN",
              "customer": {
                  "id": 3,
                  "name": "1 Load Test [DO NOT DELETE]",
                  "email": null,
                  "billingCity": null,
                  "billingCountry": null,
                  "billingPostcode": null,
                  "billingState": null,
                  "billingStreet": null,
                  "shippingCity": null,
                  "shippingCountry": null,
                  "shippingPostcode": null,
                  "shippingState": null,
                  "shippingStreet": null,
                  "contactPersonName": null,
                  "customerReferenceNo": null
                }
            }
        }
    ],
    "recordsTotal": 33155,
    "recordsFiltered": 33155,
    "status": "HAS_DATA"
}