Skip to main content
GET
List realm trips
Only an admin of the realm can list them (403 otherwise). Each trip carries the organizationId it belongs to. Filter by creation date, requester, passenger and the type, state or status of the trip. Paginated — see Pagination.

Path Parameters

realmId
string<uuid>
required

ID of the realm whose trips you want to list.

Format: UUID

Query Parameters

from
string

Only trips created on or after this day (YYYY-MM-DD, UTC).

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string

Only trips created on or before this day (YYYY-MM-DD, UTC), the whole day included.

Pattern: ^\d{4}-\d{2}-\d{2}$
vertical
enum<string>

Only trips of this type.

Available options:
AIR,
HOTEL,
BUS,
VEHICLE
state
enum<string>

Only trips in this state.

Available options:
PENDING,
RESERVED,
ISSUED,
CANCELED
status
enum<string>

Only trips in this status.

Available options:
PROCESSING_RESERVATION,
RESERVATION_FAILED,
RESERVED,
PROCESSING_ISSUE,
ISSUED,
PROCESSING_CANCELLATION,
CANCELED,
AWAITING_MANUAL_CANCELLATION,
CANCELLATION_FAILED,
FAILED,
FAILED_BY_INCONSISTENT_DATA,
FAILED_BY_UNAVAILABLE_RESOURCE,
FAILED_BY_BUDGET_EXCEEDED,
EXPIRED,
BLOCKED,
UNKNOWN,
ISSUANCE_FAILED
createdBy
string

Only trips created by this user (createdBy).

Maximum string length: 100
passengerId
string

Only trips the passenger travels on (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$
next
string

Cursor returned as next by the previous page. Omit for the first page.

limit
integer
default:15

Page size.

Required range: 1 <= x <= 100

Response

Successful response

One page of the trip list.

items
object[]
required

Trips, newest first.

next
string | null
required

Cursor for the next page. null on the last page.

Example:

"eyJjIjoiMjAyNi0xMC0wMVQxMzo0NToxMi4wMDBaIiwiaSI6IjY3MTFiNGMwZDhlMWEzMDAxMmI3YzlmMiJ9"