<!-- Generated by scripts/generate_endpoint_docs.py — do not edit by hand. -->
# `api.jobs.on_hold.list`

> `GET /job/{jobDisplayId}/onhold` — ACPortal

**Python**

```python
api.jobs.on_hold.list(job_display_id: int) -> list[ExtendedOnHoldInfo]
```

**CLI**

```bash
ab jobs on_hold list <job_display_id>
```

List on-hold records for *job_display_id*.

## Response

Returns a list of `List[ExtendedOnHoldInfo]`.

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | `Optional[int]` | no | On-hold record ID |
| `reason` | `Optional[str]` | no | Hold reason |
| `description` | `Optional[str]` | no | Hold description |
| `followUpUser` | `Optional[str]` | no | Follow-up user name |
| `followUpDate` | `Optional[str]` | no | Follow-up date |
| `status` | `Optional[str]` | no | Hold status |
| `createdDate` | `Optional[str]` | no | Created date |
| `createdByContactId` | `Optional[int]` | no | Contact ID of creator |
| `createdByJobRelation` | `Optional[str]` | no | Creator's job relation |
| `resolvedDate` | `Optional[str]` | no | Resolution date |
| `responsiblePartyTypeId` | `Optional[str]` | no | Responsible party type UUID |
| `reasonId` | `Optional[str]` | no | Hold reason UUID |
| `responsibleParty` | `Optional[str]` | no | Responsible party label |
| `comment` | `Optional[str]` | no | Hold comment |
| `startDate` | `Optional[str]` | no | Hold start date |
| `createdBy` | `Optional[str]` | no | Creator name |

---

[← Back to api.jobs](../jobs.md)