API Reference

Return a list of paginated bookings

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

Return a list of bookings details

Query Params
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'

int32
1 to 1000
Defaults to 100

Number of results per page. Maximum value 1000

int32
≥ 0
Defaults to 0

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

string

Filter by travelerId

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
string

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

string

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

string

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

string

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

string

Filter by organizationId

uuid

Filter by vehicleId

boolean

Filter by flagged status

Responses

429

Failure code. Too many incoming requests.

Updated 8 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago