API ReferenceTask GroupsExpanded List

expanded list for courier administrator

Fetches expanded task groups for the courier org with optional filters and expanded related data. | (TaskGroupExpandedForCourierAdministratorReq) -> (TaskGroupsExpandedForCourierAdministratorRes)

Authentication

AuthorizationBearer

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

Query Parameters

pageintegerOptional>=1Defaults to 1
page_sizeintegerOptional1-100Defaults to 20
sort_byenumOptional
Fields available for sorting task group expanded list results.
Allowed values:
sort_orderenumOptional
Sort order for query results
Allowed values:
filter_created_at_gtestring or nullOptionalformat: "date-time"
filter_created_at_ltestring or nullOptionalformat: "date-time"
filter_started_at_gtestring or nullOptionalformat: "date-time"
filter_started_at_ltestring or nullOptionalformat: "date-time"
filter_completed_at_gtestring or nullOptionalformat: "date-time"
filter_completed_at_ltestring or nullOptionalformat: "date-time"
filter_order_cancelledboolean or nullOptional
filter_statuseslist of enums or nullOptional
Allowed values:
filter_completedboolean or nullOptional
filter_pausedboolean or nullOptional

Request

This endpoint expects an object.
expand_tasksbooleanOptionalDefaults to false
expand_cargosbooleanOptionalDefaults to false
expand_task_artifactsbooleanOptionalDefaults to false
expand_shipper_contact_infobooleanOptionalDefaults to false
expand_shipper_org_company_namebooleanOptionalDefaults to false
expand_shipper_org_handlebooleanOptionalDefaults to false
expand_task_group_mileagebooleanOptionalDefaults to false
expand_driverbooleanOptionalDefaults to false
expand_courier_pay_driver_line_item_groupbooleanOptionalDefaults to false
expand_courier_pay_driver_rate_sheetbooleanOptionalDefaults to false
expand_courier_pay_driver_payoutbooleanOptionalDefaults to false

Response

Successful Response
task_groups_expandedlist of objects
total_countinteger

Errors