List Trip Schedules - Documentação DEVMOB

{ "data": [ { "tripScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "vehicleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "driverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "interval": 123, "departureAt": "2023-11-07T05:31:56Z", "endAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" } ], "meta": { "page": 1, "limit": 20, "total": 125, "totalPages": 7 } }

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-2c6b8d0e1f3c"

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

data

object[]

required

Show child attributes