--- title: "Retrieve a list of Jobs" method: GET path: "/v2/jobs" tags: ["Jobs"] --- # Retrieve a list of Jobs `GET /v2/jobs` Retrieves a paginated list of Jobs, optionally filtered by date range. ## Query parameters - `pageSize` number - `page` number - `field` 'created' | 'updated' | 'statusUpdated' | 'utcUpdated' - `order` 'ASC' | 'DESC' - `isOpen` boolean - `dateProperty` 'date' | 'endDate' | 'utcUpdated' | 'created' - `dateOperator` 'prev' | 'next' | 'between' - `date` string ## Headers - `Authorization` string, required ## Response `200` A paginated list of Jobs. - ResponseJobsV2Dto - `pageSize` number — The maximum number of items returned per page. - `page` number — The current page number. - `totalResults` number — The total number of results. - `hasMore` boolean — Whether there are more results. - `data` ResponseJobV2Dto[] — A list of Jobs. - `id` string — The ID of the job (prefix `JOB-`). - `uuid` string — The UUID of the job. - `serialId` number — The serial ID of the job. - `name` string — The name of the job. - `status` string — The status of the job. - `subStatus` ResponseJobJobSubStatusV2Dto - `id` string — The ID of the job sub status (prefix `JSS-`). - `name` string — The name of the job sub status. - `date` string, date-time — The date and time when the job is scheduled. - `endDate` string, date-time — The date and time when the job is scheduled to end. - `isAllDay` boolean — Whether the job is all day. - `isScheduled` boolean — Whether the job is scheduled. - `jobType` ResponseGenericJobTypeV2Dto - `id` string — The ID of the job type (prefix `JT-`). - `name` string — The name of the job type. - `adGroup` ResponseGenericAdGroupV2Dto - `id` string — The ID of the ad group (prefix `AG-`). - `name` string — The name of the ad group. - `description` string — The description of the job. - `subTotal` number — The subtotal of the job before tax and discounts. - `discountAmount` number — The job discount amount. - `taxableAmount` number — The taxable amount of the job. - `taxPercent` number — The tax percentage of the job. - `taxAmount` number — The tax amount of the job. - `costing` number — The cost amount of the job. - `techExpenses` number — The technician expenses of the job. - `tipAmount` number — The tip amount of the job. - `totalPrice` number — The total price of the job. - `amountDue` number — The amount due for the job. - `amountDueDate` string, date-time — The date and time when the job amount is due. - `converted` boolean — Whether the job was converted from a lead. - `clientInfo` ResponseJobLeadDetailsV2Dto - `clientId` string — The ID of the associated client (prefix `CL-`). - `serialId` number — The serial ID of the client. - `firstName` string — The first name of the client. - `lastName` string — The last name of the client. - `companyName` string — The company name of the client. - `email` string — The email address of the client. - `primaryExt` string — The primary extension of the client. - `primaryPhone` string — The primary phone of the client. - `secondaryExt` string — The secondary extension of the client. - `secondaryPhone` string — The secondary phone of the client. - `addressDetails` ResponseJobLeadAddressV2Dto - `country` string — The country of the client. - `state` string — The state of the client. - `city` string — The city of the client. - `zipCode` string — The zip code of the client. - `address` string — The address of the client. - `unit` string — The unit of the client. - `latitude` number — The latitude of the client. - `longitude` number — The longitude of the client. - `locationKey` string — The location key of the client. - `serviceArea` ResponseGenericServiceAreaV2Dto - `id` string — The ID of the service area (prefix `SA-`). - `name` string — The name of the service area. - `maskedNumber` ResponseJobMaskedNumberV2Dto - `number` string, required — The call masking phone number. - `extension` string, required — The call masking extension for the primary phone. - `secondaryExtension` string — The call masking extension for the secondary phone. - `team` ResponseGenericTechV2Dto[] — A list of job technicians. - `id` string — The ID of the technician (prefix `USR-`). - `name` string — The name of the technician. - `lineItems` ResponseJobLineItemV2Dto[] — A list of Job Line Items. - `id` string — The ID of the job line item (prefix `JLI-`). - `productId` number — The product ID of the item from which this line item was created. - `type` string — The type of the line item. - `name` string — The name of the line item. - `description` string — The description of the line item. - `price` number — The price of the line item. - `quantity` number — The quantity of the line item. - `total` number — The total of the line item. - `cost` number — The cost of the line item. - `taxable` boolean — Whether the line item is taxable. - `discountable` boolean — Whether the line item is discountable. - `inventoryManaged` boolean — Whether the line item is managed by inventory. - `inventorySync` boolean — Whether the line item is synced to inventory. - `optionalConverted` boolean — Whether the line item was an optional item. - `payments` ResponseGenericPaymentV2Dto[] — The payments of the job. - `id` string — The ID of the payment (prefix `PAY-`). - `type` string — The type of the payment. - `amount` number — The amount of the payment. - `tipAmount` number — The tip amount. - `tags` ResponseGenericTagV2Dto[] — A list of Job Tags. - `id` string — The ID of the tag (prefix `TAG-`). - `name` string — The name of the tag. - `customFields` ResponseGenericCustomFieldV2Dto[] — A list of Job Custom Fields. - `id` string — The ID of the custom field (prefix `CF-`). - `fieldName` string — The name of the custom field. - `value` union — The value of the custom field. Can be string, number, boolean, date string, or an array of file objects. - string — A string value. - number — A number value. - boolean — A boolean value. - object[] - `name` string — The name of the file. - `url` string — The URL of the file. - `notes` ResponseJobLeadNoteV2Dto[] — A list of Job Notes. - `id` string — The ID of the note (prefix `JNT-`). - `techName` string — The name of the technician who created the note. - `note` string — The note. - `timestamp` string, date-time — The date and time when the note was made. - `conversionDate` string, date-time — The date and time when the job was converted from a lead (based on account timezone). - `statusUpdated` string, date-time — The date and time when the job status was last updated (based on account timezone). - `updatedAt` string, date-time — The date and time when the job was last updated (based on account timezone). - `createdAt` string, date-time — The date and time when the job was created (based on account timezone). ## Other responses - `400` — Invalid query parameters. - `401` — Missing or invalid authentication token. --- [API](https://skmtc.net/workiz/apis/developer-api.md) · [All operations](https://skmtc.net/workiz/apis/developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/workiz/developer-api/revisions/14666f4db0f8/schema)