api.jobs.search_by_details

POST /job/searchByDetails — ACPortal

Python

api.jobs.search_by_details(*, data: JobSearchRequest | dict) -> list[JobSearchResult]

CLI

ab jobs search_by_details [--data ...]

POST /job/searchByDetails.

Args: data: Search filter with search_text, page, page_size, and sort_by. Accepts a :class:JobSearchRequest instance or a dict.

Request model: :class:JobSearchRequest

Request body — JobSearchRequest

Field

Type

Required

Description

searchText

Optional[str]

no

Free-text search query

pageNo

Optional[int]

no

Page number (1-based)

pageSize

Optional[int]

no

Items per page

sortBy

Optional[SortByModel]

no

Sort configuration (field index + direction)

Response

Returns a list of List[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