> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usenash.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Nash exposes two MCP servers. The docs MCP server at https://docs.usenash.com/mcp searches this documentation and needs no credentials. The Nash MCP server at https://mcp.usenash.com/mcp operates an organization's deliveries and needs a Nash API key. See https://docs.usenash.com/reference/build-with-ai.
> Use the Sandbox environment (https://api.sandbox.usenash.com/v1) for anything that creates or dispatches deliveries during development.

# List/Search Jobs

> List jobs (deliveries) with filters, sorting, and pagination. Returns a slim payload suitable for discovery; use GET /v1/jobs/<id> for full details.



## OpenAPI

````yaml get /v1/jobs
openapi: 3.1.0
info:
  title: Nash API
  version: 1.0.0
servers:
  - url: https://api.sandbox.usenash.com
    description: Sandbox API
  - url: https://api.sandbox.ap-southeast-2.usenash.com
    description: Sandbox API (Australia)
  - url: https://api.usenash.com
    description: Production API
  - url: https://api.ap-southeast-2.usenash.com
    description: Production API (Australia)
security: []
tags:
  - name: Notifications
    description: Notifications
    x-nash-topic: config
  - name: Annotate
    description: Annotate
    x-nash-topic: wismo
  - name: Notifications — Send
    description: One-off notification send without a NotificationTrigger.
    x-nash-topic: notifications
  - name: Shipping
    description: Shipping operations
    x-nash-topic: shipping
  - name: Workflow
    description: Workflow automation management
    x-nash-topic: scheduling
  - name: Workflow Execution
    description: Workflow execution history and monitoring
    x-nash-topic: scheduling
  - name: Optimization Strategies
    description: Create, read, update, and delete route optimization strategies.
    x-nash-topic: scheduling
  - name: AI Agents
    description: AI agent management — create, read, update, and delete agents
    x-nash-topic: config
  - name: AI Functions
    description: LLM-backed domain tools
    x-nash-topic: ai
  - name: Webhooks
    description: Webhook delivery inspection
    x-nash-topic: webhooks
  - name: Miscellaneous
    description: Miscellaneous
  - name: Job
    description: Job
    x-nash-topic: wismo
  - name: Batch Job
    description: Batch Job
    x-nash-topic: wismo
  - name: Order
    description: Order
    x-nash-topic: wismo
  - name: Provider
    description: Provider
    x-nash-topic: provider
  - name: Dispatch Strategies
    description: Dispatch Strategies
    x-nash-topic: scheduling
  - name: Store Locations
    description: Store Locations
    x-nash-topic: config
  - name: Vehicles
    description: Vehicles
    x-nash-topic: provider
  - name: Couriers
    description: Couriers
    x-nash-topic: provider
  - name: Shifts
    description: Shifts
    x-nash-topic: provider
  - name: Delivery Windows
    description: Delivery Windows
    x-nash-topic: config
  - name: Templates
    description: Templates
    x-nash-topic: config
  - name: Zones
    description: Zones
    x-nash-topic: config
  - name: Feedback
    description: Feedback
    x-nash-topic: reporting
  - name: Organizations
    description: Organizations
    x-nash-topic: config
  - name: Store Catalog
    description: Store Catalog
    x-nash-topic: config
  - name: Route
    description: Route
    x-nash-topic: scheduling
  - name: Messaging
    description: Messaging
    x-nash-topic: config
  - name: Billing
    description: Invoice-aligned customer billing usage
    x-nash-topic: config
  - name: Contracts
    description: Provider contract pricing and version listings
    x-nash-topic: provider
  - name: Fleet
    description: Inbound endpoints fleets call to manage their drivers.
    x-nash-topic: driver
  - name: Embed Sessions
    description: >-
      Mint short-lived, browser-safe sessions for embedded Nash Widgets.
      Authenticated with an org embed credential, which must stay on your
      backend.
    x-nash-topic: config
  - name: Event Timeline
    description: Entity-scoped event timeline + outbound provider traffic for one entity.
    x-nash-topic: internal
  - name: Optimization Fleet Projection
    description: >-
      Optimizer-facing projection of the effective fleet for a single-store
      solve
    x-nash-topic: scheduling
  - name: Inventory
    description: Store inventory catalog sync to SFTP retail destinations (e.g. Uber).
    x-nash-topic: store_catalog
  - name: Hub Scanning
    description: Scan physical packages onto their route rack at a hub.
    x-nash-topic: scheduling
  - name: Optimization Activities
    description: Optimization runs launched from the portal or the API
    x-nash-topic: scheduling
  - name: Route Restrictions
    description: Org-scoped geographic areas the route optimizer must avoid traversing.
    x-nash-topic: config
  - name: Users
    description: User, role, and organization-membership management.
    x-nash-topic: config
  - name: Widgets
    description: >-
      Org configuration for embedded Nash Widgets: parent origins, enablement,
      and embed credentials.
    x-nash-topic: config
  - name: Provider Chat
    description: Carrier-chat context for a route, scoped to the caller's organization.
    x-nash-topic: internal
  - name: Order Ingestion
    description: >-
      Internal validate, commit, and reconciliation boundary for governed Order
      imports.
    x-nash-topic: internal
paths:
  /v1/jobs:
    get:
      tags:
        - Job
      summary: List/Search Jobs
      description: >-
        List jobs (deliveries) with filters, sorting, and pagination. Returns a
        slim payload suitable for discovery; use GET /v1/jobs/<id> for full
        details.
      operationId: list_jobs_v1_jobs_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            title: Limit
            maximum: 100
            minimum: 1
            type: integer
            default: 25
            example: 25
          example: 25
        - name: offset
          in: query
          required: false
          schema:
            title: Offset
            minimum: 0
            type: integer
            default: 0
            example: 0
          example: 0
        - name: sortBy
          in: query
          description: Sort field (e.g. created_at, pickup_start_time)
          required: false
          schema:
            title: Sortby
            type: string
            description: Sort field (e.g. created_at, pickup_start_time)
            default: created_at
        - name: sortDirection
          in: query
          description: ASC or DESC
          required: false
          schema:
            title: Sortdirection
            type: string
            description: ASC or DESC
            default: DESC
        - name: startDate
          in: query
          description: Defaults to 3 days ago.
          required: false
          schema:
            title: Startdate
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: Defaults to 3 days ago.
            default: null
        - name: endDate
          in: query
          description: >-
            Defaults to 7 days from now so in-flight and scheduled deliveries
            are included.
          required: false
          schema:
            title: Enddate
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: >-
              Defaults to 7 days from now so in-flight and scheduled deliveries
              are included.
            default: null
        - name: deliveryStatuses
          in: query
          description: >-
            Comma-separated delivery statuses (e.g.
            created,accepted_by_courier,delivered)
          required: false
          schema:
            title: Deliverystatuses
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Comma-separated delivery statuses (e.g.
              created,accepted_by_courier,delivered)
            default: null
        - name: providerNames
          in: query
          description: Comma-separated provider names
          required: false
          schema:
            title: Providernames
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated provider names
            default: null
        - name: courierNames
          in: query
          description: Comma-separated courier names
          required: false
          schema:
            title: Couriernames
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated courier names
            default: null
        - name: tags
          in: query
          description: Comma-separated job tags
          required: false
          schema:
            title: Tags
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated job tags
            default: null
        - name: packageTags
          in: query
          description: Comma-separated package tags
          required: false
          schema:
            title: Packagetags
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated package tags
            default: null
        - name: pickupStoreLocationIds
          in: query
          description: Comma-separated
          required: false
          schema:
            title: Pickupstorelocationids
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated
            default: null
        - name: dropoffStoreLocationIds
          in: query
          description: Comma-separated
          required: false
          schema:
            title: Dropoffstorelocationids
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated
            default: null
        - name: search
          in: query
          description: >-
            Free-form search across IDs, external identifiers, short reference
            codes, addresses, and courier/customer names. For an exact match on
            a single field, use the dedicated filter (e.g.
            short_reference_code).
          required: false
          schema:
            title: Search
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Free-form search across IDs, external identifiers, short reference
              codes, addresses, and courier/customer names. For an exact match
              on a single field, use the dedicated filter (e.g.
              short_reference_code).
            default: null
        - name: shortReferenceCode
          in: query
          description: >-
            Exact match on the 7-digit short reference code shown on delivery
            cards. Codes are non-unique; multiple jobs may be returned. When
            provided, the default date window is widened to 90 days so older
            jobs are discoverable.
          required: false
          schema:
            title: Shortreferencecode
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Exact match on the 7-digit short reference code shown on delivery
              cards. Codes are non-unique; multiple jobs may be returned. When
              provided, the default date window is widened to 90 days so older
              jobs are discoverable.
            default: null
        - name: customerName
          in: query
          description: >-
            Fuzzy, case-insensitive substring match on the end customer's name
            (pickup or dropoff full name) over the denormalized task. Use this
            to locate a delivery when the caller only knows the customer's name.
            Matches names only — not business names, addresses, or courier names
            (use `search` for broader free-form matching). When provided, the
            default date window is widened to 90 days so older deliveries are
            discoverable.
          required: false
          schema:
            title: Customername
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Fuzzy, case-insensitive substring match on the end customer's name
              (pickup or dropoff full name) over the denormalized task. Use this
              to locate a delivery when the caller only knows the customer's
              name. Matches names only — not business names, addresses, or
              courier names (use `search` for broader free-form matching). When
              provided, the default date window is widened to 90 days so older
              deliveries are discoverable.
            default: null
        - name: isBatch
          in: query
          description: Filter to batch jobs only
          required: false
          schema:
            title: Isbatch
            anyOf:
              - type: boolean
              - type: 'null'
            description: Filter to batch jobs only
            default: null
        - name: hasNotes
          in: query
          description: Filter to jobs with notes
          required: false
          schema:
            title: Hasnotes
            anyOf:
              - type: boolean
              - type: 'null'
            description: Filter to jobs with notes
            default: null
        - name: city
          in: query
          description: Comma-separated pickup/dropoff cities
          required: false
          schema:
            title: City
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated pickup/dropoff cities
            default: null
        - name: state
          in: query
          description: Comma-separated pickup/dropoff states
          required: false
          schema:
            title: State
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated pickup/dropoff states
            default: null
        - name: country
          in: query
          description: Comma-separated pickup/dropoff countries
          required: false
          schema:
            title: Country
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated pickup/dropoff countries
            default: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobsListResponse'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NashValidationError'
components:
  schemas:
    JobsListResponse:
      title: JobsListResponse
      required:
        - results
        - totalCount
        - limit
        - offset
      type: object
      properties:
        results:
          title: Results
          type: array
          items:
            $ref: '#/components/schemas/JobListItem'
        totalCount:
          title: Totalcount
          type: integer
        limit:
          title: Limit
          type: integer
        offset:
          title: Offset
          type: integer
    NashValidationError:
      title: NashValidationError
      required:
        - error
        - response_status
        - RequestID
      type: object
      properties:
        error:
          $ref: '#/components/schemas/NashErrorDetails'
        response_status:
          title: Response Status
          type: string
        RequestID:
          title: Requestid
          type: string
    JobListItem:
      title: JobListItem
      required:
        - id
      type: object
      properties:
        id:
          title: Id
          type: string
        externalIdentifier:
          title: Externalidentifier
          anyOf:
            - type: string
            - type: 'null'
          default: null
        shortReferenceCode:
          title: Shortreferencecode
          anyOf:
            - type: string
            - type: 'null'
          default: null
        status:
          title: Status
          anyOf:
            - type: string
            - type: 'null'
          default: null
        isBatch:
          title: Isbatch
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
        createdAt:
          title: Createdat
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
        routeId:
          title: Routeid
          anyOf:
            - type: string
            - type: 'null'
          default: null
        portalUrl:
          title: Portalurl
          anyOf:
            - type: string
            - type: 'null'
          default: null
        pickup:
          anyOf:
            - $ref: '#/components/schemas/JobLocationSummary'
            - type: 'null'
          default: null
        dropoff:
          anyOf:
            - $ref: '#/components/schemas/JobLocationSummary'
            - type: 'null'
          default: null
        delivery:
          anyOf:
            - $ref: '#/components/schemas/JobDeliverySummary'
            - type: 'null'
          default: null
    NashErrorDetails:
      title: NashErrorDetails
      required:
        - code
        - message
      type: object
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
        details:
          title: Details
          anyOf:
            - type: object
              additionalProperties: true
            - type: 'null'
          description: >-
            Structured error context; shape depends on `code`. For
            `VALIDATION_ERRORS` (HTTP 422) it is `{"fields": [{"loc": [...],
            "msg": "...", "type": "..."}]}` — one entry per invalid field, where
            `loc` is the field path, `msg` the human-readable message, and
            `type` the machine-readable error type (e.g. `string_type`,
            `missing`).
          default: null
    JobLocationSummary:
      title: JobLocationSummary
      type: object
      properties:
        businessName:
          title: Businessname
          anyOf:
            - type: string
            - type: 'null'
          default: null
        firstName:
          title: Firstname
          anyOf:
            - type: string
            - type: 'null'
          default: null
        lastName:
          title: Lastname
          anyOf:
            - type: string
            - type: 'null'
          default: null
        address:
          title: Address
          anyOf:
            - type: string
            - type: 'null'
          default: null
        city:
          title: City
          anyOf:
            - type: string
            - type: 'null'
          default: null
        state:
          title: State
          anyOf:
            - type: string
            - type: 'null'
          default: null
        country:
          title: Country
          anyOf:
            - type: string
            - type: 'null'
          default: null
    JobDeliverySummary:
      title: JobDeliverySummary
      type: object
      properties:
        id:
          title: Id
          anyOf:
            - type: string
            - type: 'null'
          default: null
        providerName:
          title: Providername
          anyOf:
            - type: string
            - type: 'null'
          default: null
        status:
          title: Status
          anyOf:
            - type: string
            - type: 'null'
          default: null
        courierName:
          title: Couriername
          anyOf:
            - type: string
            - type: 'null'
          default: null
        trackingUrl:
          title: Trackingurl
          anyOf:
            - type: string
            - type: 'null'
          default: null
        priceCents:
          title: Pricecents
          anyOf:
            - type: integer
            - type: 'null'
          default: null
        currency:
          title: Currency
          anyOf:
            - type: string
            - type: 'null'
          default: null

````