---
title: "List jobs"
method: GET
path: "/jobs"
tags: ["Jobs"]
---

# List jobs

`GET /jobs`

## Request

- Base URL: `https://api.shopvox.com/v1`
- URL: `https://api.shopvox.com/v1/jobs`
- Auth: API key in query parameter `account_id` and API key in query parameter `authToken`
- TypeScript: <https://skmtc.dev/shopvox/apis/shopvox-public-api/docs/jobs/get.ts> (a function with typed inputs; its response is checked against the schema)

**Plan: Restricted.** Usage of this endpoint is off by default and must be enabled for
the account - contact shopVOX support. As with every index endpoint, `txn_type` /
`txn_number` are required unless the account also has the `index_api_enabled` flag
(see Pagination & filter gating).

## Query parameters

- `txn_type` 'invoice' | 'sales_order' | 'quote'
- `txn_number` integer
- `page` integer
- `per_page` integer

## Response `200`

OK

- object
  - `stats` PaginationStats: Pagination metadata attached as `stats` (or `meta` on assets) to index responses. The **quotes** list uses a different block - see `QuoteListStats`.
    - `totalCount` integer
    - `page` integer
    - `perPage` integer
    - `totalPages` integer
    - `prevPage` integer, nullable
    - `nextPage` integer, nullable
    - `outOfRange` boolean
  - `jobs` Job[]
    - `id` string, uuid
    - `active` boolean
    - `name` string
    - `description` string, nullable
    - `workflowState` string, nullable
    - `companyId` string, uuid, nullable
    - `contactId` string, uuid, nullable
    - `assignedToId` string, uuid, nullable
    - `productionManagerId` string, uuid, nullable
    - `salesRepId` string, uuid, nullable
    - `jobTemplateId` string, uuid, nullable
    - `orderId` string, uuid, nullable
    - `orderLineItemId` string, uuid, nullable
    - `orderNumber` string, nullable
    - `lineNumber` integer, nullable
    - `projectNumber` string, nullable
    - `priority` string, nullable
    - `quantity` number, nullable
    - `requireProofing` boolean, nullable
    - `hasOrder` boolean
    - `daysLeft` integer, nullable
    - `dueDate` string, date, nullable
    - `dueTime` string, nullable
    - `dueDateFrom` string, nullable
    - `dueDateTo` string, nullable
    - `dueDateTimeFrom` string, nullable
    - `dueDateTimeTo` string, nullable
    - `currentStageId` string, uuid, nullable
    - `currentStageName` string, nullable
    - `currentStepId` string, uuid, nullable
    - `currentStepName` string, nullable
    - `bomDetails` string, nullable
    - `designDetails` string, nullable
    - `productionDetails` string, nullable
    - `shippingDetails` string, nullable
    - `installDetails` string, nullable
    - `lastEvent` string, nullable
    - `lastEventAt` string, date-time, nullable
    - `currentProofUrl` string, nullable
    - `currentProofThumbnailUrl` string, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `divisionId` string, uuid, nullable
    - `division` NamedRef: Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string
    - `company` NamedRef: Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string
    - `contact` NamedRef: Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string
    - `salesRep` Party: A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `productionManager` Party: A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `assignedTo` Party: A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `projectManager` Party: A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `designer` Party: A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `lineItems` object[]
      - `id` string, uuid
      - `lineNumber` integer, nullable
      - `position` integer
      - `name` string, nullable
      - `description` string, nullable
      - `quantity` number, nullable
      - `workflowState` string, nullable
      - `uom` string, nullable

## Other responses

- `401`: Missing/expired credentials, an index request without a required filter, or the plan does not include this endpoint.

---

[API](https://skmtc.dev/shopvox/apis/shopvox-public-api.md) - [All operations](https://skmtc.dev/shopvox/apis/shopvox-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shopvox/apis/shopvox-public-api/revisions/c02128f70b33?raw)