Return a list of paginated bookings

get

https://people-mobility.api.eu1.scalar.zf.com/v1/bookings

Return a list of bookings details

📘
The rate limit for this APi is small.

Query Params

sort

string

Defaults to createdAt+desc

Sorting the results by a specific order. All the possible values are: 'pickupTime+ASC', 'pickupTime+DESC', 'createdAt+ASC' or 'createdAt+DESC'

limit

int32

1 to 1000

Defaults to 100

Number of results per page. Maximum value 1000

offset

int32

≥ 0

Defaults to 0

Number of results to be skipped before returning a list of items

travelerId

string

Filter by travelerId

bookingId

uuid

Filter by bookingId

status

array of strings

Filter by statuses. All the possible values are 'Created', 'Accepted', 'Canceled', 'Rejected', 'Completed', 'Error' and 'NoShow'

status

desiredJourneyStartTimeFrom

string

Date and time (ISO 8601) - return bookings that begin after this instant

desiredJourneyStartTimeTo

string

Date and time (ISO 8601) - return bookings that begin up to this instant

lastModifiedFrom

string

Date and time (ISO 8601) - return bookings that were modified after this instant

lastModifiedTo

string

Date and time (ISO 8601) - return bookings that were modified up to this instant

organizationId

string

Filter by organizationId

vehicleId

uuid

Filter by vehicleId

flagged

boolean

Filter by flagged status

Responses

429

Failure code. Too many incoming requests.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK.

400Failure code. The request was unacceptable, parameters are invalid.

401Failure code. Unauthorized access.

403Failure code. Forbidden access.

404Failure code. Not Found.

500Failure code. Indicates an internal server error (unhandled exception).