---
title: "Read Job Summary"
method: GET
path: "/settings/job-summary"
tags: ["job-summary"]
---

# Read Job Summary

`GET /settings/job-summary`

## 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-summary`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## 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

## Response `200`

Successful Response

- JobSummaryResponse: Rules in stacking order, in-effect before scheduled; `detail` is what a job gets when no more specific rule sets one.
  - `rules` JobSummaryRuleResponse[], required
    - `entry_key` string, required
    - `label` string, required
    - `job_types` NamedEntity[], required
      - `id` integer, required
      - `name` string, nullable, required
    - `business_units` NamedEntity[], required
      - `id` integer, required
      - `name` string, nullable, required
    - `sources` string[], required
    - `instructions` string, nullable, required
    - `detail` 'CONVERSATION_SUMMARY' | 'FULL_CONVERSATION' | 'CONVERSATION_LINK', nullable, required
    - `example` JobSummaryExample, required: A summary Jenny generated under the rule when she saved it, for people reviewing the rule.
      - `summary` string, required
      - `engagement_id` string, required
      - `generated_at` string, date-time, required
    - `status` 'in_effect' | 'scheduled', required
    - `valid_from` string, date-time, nullable
    - `valid_until` string, date-time, nullable
  - `detail` 'CONVERSATION_SUMMARY' | 'FULL_CONVERSATION' | 'CONVERSATION_LINK', required
  - `baseline` string, required

## 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)