> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List passengers > Lists the organization's passengers, followed by its users who are not passengers yet. 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. ## OpenAPI ````yaml /api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers openapi: 3.0.3 info: title: Travel version: 1.0.0 description: >- Portão 3 travel API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Passenger directory, trips and the search proxy (air/hotel/bus/vehicle). Every route validates path, query and body through a zod Input class (`travel/src/domain/*/input`), which documents its parameters and body; responses are the named interfaces in `travel/src/domain/*/response.ts`. Confidence tiers: generated:typed=53 copied:manual=0 unknown=0. servers: - url: https://api.travel.v2.portao3.com.br/ description: production - url: https://api.travel.dev.3pers.com.br/ description: development security: [] tags: - name: Passengers - name: Trips - name: Air search - name: Hotel search - name: Bus search - name: Vehicle search paths: /realms/{realmId}/organizations/{organizationId}/passengers: get: tags: - Passengers summary: List passengers description: >- Lists the organization's passengers, followed by its users who are not passengers yet. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdPassengers parameters: - name: realmId in: path required: true description: |- ID of your realm. Format: `UUID` schema: type: string format: uuid example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b - name: organizationId in: path required: true description: |- ID of the organization whose passengers you want to list. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: name in: query required: false description: Only rows whose name contains this text (case-insensitive). schema: type: string maxLength: 120 example: mariana - name: email in: query required: false description: Only rows whose e-mail contains this text (case-insensitive). schema: type: string maxLength: 254 example: acme.com.br - name: document in: query required: false description: >- Only rows whose CPF contains these digits, with or without punctuation. schema: type: string maxLength: 30 example: '52998224725' - name: next in: query required: false description: >- Cursor returned as `next` by the previous page. Omit for the first page. schema: type: string example: eyJwIjoiNjcxMGEzZjJjOWU3N2IwMDEyYTRkNWUxIn0= - name: limit in: query required: false description: Page size. schema: default: 15 type: integer minimum: 1 maximum: 100 example: 15 responses: '200': description: Successful response content: application/json: schema: type: object properties: items: type: array items: anyOf: - type: object properties: id: type: string description: ID of the passenger. example: 6710a3f2c9e77b0012a4d5e1 realmId: type: string description: ID of the realm the passenger belongs to. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizationId: type: string description: ID of the organization the passenger belongs to. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid source: type: string enum: - PASSENGER description: >- Always `PASSENGER` for a passenger. In the passenger list, it tells a passenger apart from a user who is not a passenger yet (`USER`). example: PASSENGER profileComplete: type: boolean enum: - true description: >- Always `true`: a passenger has every field a booking needs. example: true userId: type: string description: >- ID of the organization user this passenger is linked to. Omitted for a passenger who is not a user. A linked passenger's `name`, first e-mail and CPF come from the user and can't be changed. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid name: type: string description: >- Full name, as it appears on the passenger's travel documents. example: Mariana Costa gender: type: string enum: - MALE - FEMALE description: Gender. example: FEMALE birthDate: type: string description: Date of birth (`YYYY-MM-DD`). example: '1990-04-17' emails: type: array items: type: string example: mariana.costa@acme.com.br description: >- Contact e-mails. The first one is the main contact. --- Example: `["mariana.costa@acme.com.br"]` phoneNumbers: type: array items: type: string example: '+5511987654321' description: |- Contact phone numbers, in international format. --- Example: `["+5511987654321"]` documents: type: object properties: CPF: description: Brazilian taxpayer ID (CPF), 11 digits. type: object properties: code: type: string description: >- Document number as printed, digits and letters only (no punctuation). example: '52998224725' issueCountry: type: string description: >- Country that issued the document (ISO 3166-1 alpha-2). Always `BR` for `CPF`, `RG` and `CNH`. example: BR required: - code - issueCountry nullable: true RG: description: Brazilian national identity card (RG). type: object properties: code: type: string description: >- Document number as printed, digits and letters only (no punctuation). example: '52998224725' issueCountry: type: string description: >- Country that issued the document (ISO 3166-1 alpha-2). Always `BR` for `CPF`, `RG` and `CNH`. example: BR required: - code - issueCountry nullable: true PASSPORT: description: Passport. type: object properties: code: type: string description: >- Document number as printed, digits and letters only (no punctuation). example: '52998224725' issueCountry: type: string description: >- Country that issued the document (ISO 3166-1 alpha-2). Always `BR` for `CPF`, `RG` and `CNH`. example: BR expirationDate: type: string nullable: true description: >- Expiration date (`YYYY-MM-DD`). `null` for a passport registered before the date was required. example: '2031-04-17' required: - code - expirationDate - issueCountry nullable: true CNH: description: Brazilian driver's license (CNH). type: object properties: code: type: string description: >- Document number as printed, digits and letters only (no punctuation). example: '52998224725' issueCountry: type: string description: >- Country that issued the document (ISO 3166-1 alpha-2). Always `BR` for `CPF`, `RG` and `CNH`. example: BR required: - code - issueCountry nullable: true description: Identity documents. address: type: object properties: shortAddress: type: string description: The address in a single line. example: >- Av. Paulista, 1000 - Bela Vista, São Paulo - SP adressLines: type: array items: type: string example: Av. Paulista, 1000 description: >- The address in postal lines. The field name is spelled `adressLines`. --- Example: `["Av. Paulista, 1000","Bela Vista"]` locality: type: string description: City. example: São Paulo administrativeArea: type: string description: State or province code. example: SP administrativeAreaName: type: string description: State or province name. example: São Paulo postalCode: type: string description: Postal code. example: 01310-100 country: type: string description: Country (ISO 3166-1 alpha-2). example: BR timezone: type: string description: IANA time zone of the address. example: America/Sao_Paulo coordinates: type: object properties: lat: type: number description: Latitude. example: -23.5614 lng: type: number description: Longitude. example: -46.6559 required: - lat - lng description: Location of the address. required: - shortAddress - adressLines - locality - administrativeArea - administrativeAreaName - postalCode - country - timezone - coordinates description: Home address. loyalty: type: object additionalProperties: type: string description: >- Loyalty program numbers, keyed by carrier code. Omitted when there are none. --- Example: `{"LA":"123456789"}` example: LA: '123456789' customFields: type: object additionalProperties: {} description: >- Values of the organization's passenger custom fields, keyed by the custom field's `slug`. Empty when none were set. --- Example: `{"cost-center":"CC-1020"}` example: cost-center: CC-1020 status: type: string enum: - ACTIVE - DELETED description: >- Status of the passenger. Only `ACTIVE` passengers are returned. example: ACTIVE createdAt: type: string description: When the passenger was created. example: '2026-10-01T13:45:12.000Z' format: date-time updatedAt: type: string description: When the passenger was last changed. example: '2026-10-01T13:45:12.000Z' format: date-time required: - id - realmId - organizationId - source - profileComplete - name - gender - birthDate - emails - phoneNumbers - documents - address - customFields - status description: >- A passenger of the organization: a traveler who can be booked on trips. - type: object properties: realmId: type: string description: ID of the realm the user belongs to. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizationId: type: string description: ID of the organization the user belongs to. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid source: type: string enum: - USER description: >- Always `USER`: a user who is not a passenger yet. example: USER profileComplete: type: boolean enum: - false description: >- Always `false`: a user lacks fields a booking needs (gender, phone and address at least). example: false userId: type: string description: ID of the user. example: 9b2d4f6a-1c3e-4a5b-8d7f-0e1a2b3c4d5e format: uuid name: type: string description: Full name of the user. example: Rafael Lima email: type: string description: E-mail of the user. example: rafael.lima@acme.com.br document: type: string description: >- CPF of the user, digits only. Omitted when the user has none. example: '39053344705' birthDate: type: string description: >- Date of birth (`YYYY-MM-DD`). Omitted when the user has none. example: '1987-11-02' required: - realmId - organizationId - source - profileComplete - userId - name description: >- A user of the organization who is not a passenger yet. Create a passenger linked to them (`userId`) before booking them on a trip. description: >- Passengers first, sorted by name; once they run out, users of the organization who are not passengers yet (`source: USER`), also sorted by name. next: type: string nullable: true description: Cursor for the next page. `null` on the last page. example: eyJwIjoiNjcxMGEzZjJjOWU3N2IwMDEyYTRkNWUxIn0= required: - items - next description: One page of the passenger list. '422': description: >- `BAD_REQUEST` — A path or query parameter is invalid; `fields` lists each one. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - TRAVEL description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BAD_REQUEST origin: TRAVEL message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: name message: 'Too big: expected string to have <=120 characters' code: NAME_MAX ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.