Skip to main content
GET
List Benefit Categories

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
number
default:1

Page number

Example:

1

pageSize
number
default:20

Items per page

Example:

20

Generic filter that matches against

  • code
  • name
Example:

"student"

sort
string

Sort expression. Use comma-separated fields and prefix with - for descending order.

Example:

"-createdAt"

status
enum<string>

Fare benefit category status

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

type
enum<string>

Fare benefit type

Available options:
GRATUITY,
DISCOUNT
Example:

"DISCOUNT"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List fare benefit categories

data
object[]
required
meta
object
required