Skip to main content
GET
List passengers
Passengers come first, sorted by name. Once they run out, the list continues with the organization’s active users who have no passenger (source: USER, profileComplete: false), also sorted by name — create a passenger linked to one of them (userId) before booking them on a trip. The name, email and document filters apply to both kinds of row.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose passengers you want to list.

Format: UUID

Query Parameters

name
string

Only rows whose name contains this text (case-insensitive).

Maximum string length: 120
email
string

Only rows whose e-mail contains this text (case-insensitive).

Maximum string length: 254
document
string

Only rows whose CPF contains these digits, with or without punctuation.

Maximum string length: 30
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 passenger list.

items
object[]
required

Passengers first, sorted by name; once they run out, users of the organization who are not passengers yet (source: USER), also sorted by name.

A passenger of the organization: a traveler who can be booked on trips.

next
string | null
required

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

Example:

"eyJwIjoiNjcxMGEzZjJjOWU3N2IwMDEyYTRkNWUxIn0="