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

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

**Python**

```python
api.jobs.note.list(job_display_id: int, *, category: str | None = None, task_code: str | None = None) -> list[JobNote]
```

**CLI**

```bash
ab jobs note list <job_display_id> [--category ...] [--task-code ...]
```

List notes attached to *job_display_id* (``GET /job/{jobDisplayId}/note``).

Args:
    job_display_id: Job display ID.
    category: Note category filter.
    task_code: Task code filter.

## Query parameters — `JobNoteListParams`

| Field | Type | Required | Description |
|---|---|---|---|
| `category` | `Optional[str]` | no | Note category filter |
| `taskCode` | `Optional[str]` | no | Task code filter |

## Response

Returns a list of `List[JobNote]`.

| Field | Type | Required | Description |
|---|---|---|---|
| `createdDate` | `Optional[datetime]` | no | Creation timestamp |
| `modifiedDate` | `Optional[datetime]` | no | Last modification timestamp |
| `createdBy` | `Optional[str]` | no | Creator identifier |
| `modifiedBy` | `Optional[str]` | no | Last modifier identifier |
| `id` | `Optional[int]` | no | Note ID |
| `comment` | `Optional[str]` | no | Note content |
| `isImportant` | `Optional[bool]` | no | Flagged as important |
| `isCompleted` | `Optional[bool]` | no | Completion status |
| `author` | `Optional[str]` | no | Author name |
| `modifiyDate` | `Optional[str]` | no | Last modified (API typo preserved) |
| `taskCode` | `Optional[str]` | no | Associated timeline task |

---

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