Get all corporate travelers

GET 
/v1/corporates/:id/travelers

Retrieves a paginated list of corporate travelers for a specific corporate account. Supports filtering by name, phone, and email.

Request

Path Parameters

id stringrequired

Corporate ID

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number (default: 1)

limit number

Possible values: >= 1

Default value: 10

Items per page (default: 10)

corporateId string

Filter by corporate ID

name string

Filter by traveler name (case-insensitive)

phone string

Filter by phone number

email string

Filter by email

Responses

200

List of corporate travelers retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the corporate traveler
firstName stringrequired
The first name of the corporate traveler
lastName string
The last name of the corporate traveler
phone stringrequired
The phone of the corporate traveler
email stringrequired
The email of the corporate traveler
gender numberrequired
The gender of the corporate traveler
dateOfBirth stringrequired
The date of birth of the corporate traveler
address stringrequired
The address of the corporate traveler
city stringrequired
The city of the corporate traveler
state stringrequired
The state of the corporate traveler
zipCode stringrequired
The zip code of the corporate traveler
country stringrequired
The country of the corporate traveler
jobTitle stringrequired
The job title of the corporate traveler
department stringrequired
The department of the corporate traveler
corpDivision stringrequired
The corp division of the corporate traveler
managerName stringrequired
The manager name of the corporate traveler
managerEmail stringrequired
The manager email of the corporate traveler
assistantEmail stringrequired
The assistant email of the corporate traveler
corpId stringrequired
The corp ID of the corporate traveler
corpPo stringrequired
The corp PO of the corporate traveler
isActive booleanrequired
Whether the corporate traveler is active
createdDate date-timerequired
The created date of the corporate traveler
latestUpdate date-timerequired
The latest update date of the corporate traveler
]
total numberrequired

The total number of items

page numberrequired

The current page

limit numberrequired

The number of items per page

totalPages numberrequired

The total number of pages

Example (from schema)

{
  "data": [
    {
      "_id": "1234567890",
      "firstName": "James",
      "lastName": "Bond",
      "phone": "+1234567890",
      "email": "jamesbond@goodjourney.io",
      "gender": 0,
      "dateOfBirth": "1990-01-01",
      "address": "123 Main St",
      "city": "New York",
      "state": "NY",
      "zipCode": "10001",
      "country": "USA",
      "jobTitle": "CEO",
      "department": "Finance",
      "corpDivision": "Finance",
      "managerName": "John Doe",
      "managerEmail": "john.doe@goodjourney.io",
      "assistantEmail": "assistant@goodjourney.io",
      "corpId": "1234567890",
      "corpPo": "1234567890",
      "isActive": true,
      "createdDate": "2021-01-01T00:00:00.000Z",
      "latestUpdate": "2021-01-01T00:00:00.000Z"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

404

Corporate not found

Loading...