api.jobs.search

GET /job/search — ACPortal

Python

api.jobs.search(*, job_display_id: int | None = None) -> JobSearchResult

CLI

ab jobs search [--job-display-id ...]

GET /job/search (ACPortal) — query params.

Query parameters — JobSearchParams

Field	Type	Required	Description
jobDisplayId	Optional[int]	no	Job display ID to search for

Response

Returns JobSearchResult.

Field	Type	Required	Description
jobId	Optional[str]	no	Job UUID
jobDisplayId	Optional[int]	no	Job display ID
itemsCount	Optional[int]	no	Number of items in job
pickupDetails	Optional[JobSearchTransportDetails]	no	Pickup details
deliveryDetails	Optional[JobSearchTransportDetails]	no	Delivery details
accessLevel	Optional[int]	no	Access level bitmask

---

← Back to api.jobs