List colleagues in my account

Return a page of colleagues in the caller's own account — people who already have their own account and can be picked as the traveler for a booking made on their behalf. Optional query is a case-insensitive substring of the stored full name, applied upstream before pagination. This list is never cached or stored locally.

With bookingId, people already travelling on that train booking are left out of each page (so a page can hold fewer than limit items while nextOffset still advances), and a carnet booking lists only people matching its invoice profiles and returns personCreationAvailable: false.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 20
integer
≥ 0
Defaults to 0
length ≤ 100

Case-insensitive substring of the colleague's stored full name. Omit or leave blank for the unfiltered directory.

length ≥ 1

Train booking the colleague is being picked for. People already travelling on it are left out, and a carnet booking only lists people matching its invoice profiles and reports personCreationAvailable: false.

Responses

401

Missing or invalid authentication

403

Provider denied the request

404

Booking not found

502

Upstream returned a malformed colleague record

503

Colleague directory is temporarily unavailable

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