Gozem Developer DocsDocs
Courier API › Trip

List Trips

gethttps://sandbox-api.gozem.co/courier/v1/trips

List past trips, optionally filtered by date or status.

Query parameters

string

Filter trips by status

pendingexpiredassignedat_pickupstartedcanceledcompleted
string

Earliest creation date. Defaults to 30 days ago.

date-time
string

Latest creation date. Defaults to now, and is capped 30 days after `from`.

date-time
number

Trips to return per page. Defaults to 25.

1 to 200
number

Trips to skip, newest first. Defaults to 0.

min 0

Response 200

dataarray of objectrequired

Trips matching the query, newest first

object
assigned_atstring

Driver assigned timestamp

date-time
canceled_atstring

Trip canceled timestamp

date-time
completed_atstring

Delivery completed timestamp

date-time
created_atstringrequired

Trip creation timestamp

date-time
distance_kmnumber

Total distance in kilometers

min 0
driverobject

Driver handling the trip. Absent until one is assigned.

namestringrequired

Driver name

phonestringrequired

Driver phone number

vehicle_platestringrequired

Vehicle plate number

vehicle_typestringrequired

Vehicle type and details

duration_minutesnumber

Total duration in minutes

min 0
fareobjectrequired

Fare charged for the trip.

amountnumberrequired

Total fare amount

currency_codestringrequired

Currency code

guidstringrequired

Unique trip identifier

started_atstring

Package picked up timestamp

date-time
statusstringrequired

Current status of the trip

pendingexpiredassignedat_pickupstartedcanceledcompleted
titlestring

Trip title

messagestringrequired

Human-readable outcome. Defaults to `Ok`.

metaobjectrequired

Where this page sits in the full result set

limitnumberrequired

Records returned in this page

offsetnumberrequired

Records skipped before this page

totalnumberrequired

Records matching the query, across all pages

successbooleanrequired

Always `true` on a success response.

true

Errors

Every failure returns the same envelope. Branch on code — it is the stable contract; message is human-facing and may be reworded or localized. See the error reference for what each code means.

400401403404405409413415429500502