`api.documents.list`

GET /documents/list — ACPortal

Python

api.documents.list(job_display_id: str | int) -> list[Document]

CLI

ab documents list <job_display_id>

GET /documents/list

Query parameters — `DocumentListParams`

Field	Type	Required	Description
`jobDisplayId`	`Optional[str]`	no	Job display identifier

Returns a list of List[Document].

Field	Type	Required	Description
`id`	`str \| int \| None`	no	Unique identifier
`path`	`Optional[str]`	no	Document storage path
`thumbnailPath`	`Optional[str]`	no	Thumbnail path
`description`	`Optional[str]`	no	Document description
`typeName`	`Optional[str]`	no	Document type name
`typeId`	`Optional[int]`	no	Document type ID
`fileName`	`Optional[str]`	no	Original file name
`shared`	`Optional[int]`	no	Sharing level (0=private)
`tags`	`Optional[list]`	no	Document tags
`jobItems`	`Optional[list]`	no	Associated job items