---
title: "Preview Job Limits"
method: POST
path: "/settings/job-limits/preview"
tags: ["job-limits"]
---

# Preview Job Limits

`POST /settings/job-limits/preview`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/settings/job-limits/preview`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Whether the day would be offered under the saved limits, or under `policies` when given. Saves nothing.

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- JobLimitPreviewRequest: One day or arrival window to check; `policies` previews a draft set of limits instead of the saved ones.
  - `candidate` CandidateInput, required: A day or window to evaluate, before the request's current time and job-type groups are attached.
    - `requested_system_count` integer, nullable: Complete systems requested for this visit; null when unknown, never inferred from equipment components.
    - `agent_scope_known` boolean: Whether the caller's agent and roster are known, including no agent
    - `agent_id` string, nullable: Running agent ID from trusted request context
    - `roster_id` string, nullable: Running roster ID; null for a known caller without a roster
    - `job_type_id` integer, required
    - `business_unit_ids` integer[], required
    - `kind` 'date' | 'window', required
    - `local_date` string, required: Organization-local YYYY-MM-DD being offered, not the evaluation date
    - `timezone` string, required
    - `window_start` string, date-time, nullable
    - `window_end` string, date-time, nullable
    - `arrival_window_start` string, date-time, nullable: Start of the customer-facing arrival window
    - `arrival_window_end` string, date-time, nullable: End of the customer-facing arrival window
    - `exclude_appointment_id` integer, nullable
    - `arrival_window_id` integer, nullable: ServiceTitan arrival window the candidate offers
    - `business_unit_group_ids` string[], nullable: Business unit groups the business units belong to; null when the caller did not resolve them
    - `zone_id` integer, nullable: Zone of the service location; null when the caller did not resolve it
  - `policies` object, nullable
  - `technician_ids` integer[], nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

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