API ReferenceTask GroupsExpanded

List for courier driver

Lists expanded task groups for courier driver with filtering, sorting, and pagination. | authz_personas=[courier_driver] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sort_byenum or nullOptional
sort_orderenumOptionalDefaults to descending
Allowed values:
pageintegerOptional>=1Defaults to 1
page_sizeintegerOptional1-100Defaults to 20
filter_statuslist of enums or nullOptional
filter_draft_started_at_timestamp_ltestring or nullOptionalformat: "date-time"
filter_draft_started_at_timestamp_gtestring or nullOptionalformat: "date-time"
filter_staged_at_timestamp_ltestring or nullOptionalformat: "date-time"
filter_staged_at_timestamp_gtestring or nullOptionalformat: "date-time"
filter_in_progress_at_timestamp_ltestring or nullOptionalformat: "date-time"
filter_in_progress_at_timestamp_gtestring or nullOptionalformat: "date-time"
filter_completed_at_timestamp_ltestring or nullOptionalformat: "date-time"
filter_completed_at_timestamp_gtestring or nullOptionalformat: "date-time"
filter_skipped_at_timestamp_ltestring or nullOptionalformat: "date-time"
filter_skipped_at_timestamp_gtestring or nullOptionalformat: "date-time"
filter_exception_at_timestamp_ltestring or nullOptionalformat: "date-time"
filter_exception_at_timestamp_gtestring or nullOptionalformat: "date-time"

Request

This endpoint expects an object.
expand_forwarder_org_company_namebooleanOptionalDefaults to false
expand_forwarder_org_handlebooleanOptionalDefaults to false
expand_shipper_org_company_namebooleanOptionalDefaults to false
expand_off_chrt_shipper_org_company_namebooleanOptionalDefaults to false
expand_tasksbooleanOptionalDefaults to false
expand_cargosbooleanOptionalDefaults to false
expand_task_artifactsbooleanOptionalDefaults to false
expand_shipper_contactsbooleanOptionalDefaults to false
expand_driverbooleanOptionalDefaults to false
expand_courier_org_company_namebooleanOptionalDefaults to false
expand_courier_org_handlebooleanOptionalDefaults to false

Response

Successful Response
task_groups_expandedlist of objects
total_countinteger

Errors