Skip to main content
GET
List Trip Schedules

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

filter
string

Generic filter that matches against

  • name
Example:

"São Paulo"

driverId
string<uuid>

Driver identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e"

routeId
string<uuid>

Route identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d"

status
enum<string>

Trip schedule status

Available options:
ACTIVE,
PAUSED,
ARCHIVED
Example:

"ACTIVE"

vehicleId
string<uuid>

Vehicle identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
departureAt,
createdAt,
updatedAt
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List trip schedules

data
object[]
required
meta
object
required