Get passengers

GET/passengers

Query Parameters

Parameter	Type	Required	Description
`sort`	string	No	Sort by field:asc/desc Allowed: asc, desc
`type`	"default"	"student"	"employee"
`ids`	string[]	No	Passenger ids to include
`excludeIds`	string[]	No	Passenger ids to exclude
`profiles`	string[]	No	Profiles filter
`limit`	number	Yes	-
`page`	number	Yes	-
`search`	string	No	-

Example Response

{
  "page": 1,
  "limit": 20,
  "totalPages": 1,
  "totalResults": 2,
  "records": [
    {
      "id": 10,
      "firstName": "Alice",
      "lastName": "Smith",
      "email": "alice.smith@example.com",
      "phone": "+15551234567",
      "activeSince": 1700000000,
      "baseAddress": "123 Main St",
      "occupationAddress": "456 Work Ave",
      "alternateAddress": "789 Alt Rd",
      "profile": "Student",
      "supplier": "School",
      "createdBy": "Admin",
      "createdAt": 1700000000,
      "type": "student",
      "tags": [
        {
          "key": "tier",
          "value": "gold"
        }
      ]
    }
  ]
}

Query Parameters

Example Response

On this page