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

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

filter
string

Generic filter that matches against

  • code
  • name
Example:

"student"

status
enum<string>
Available options:
ACTIVE,
INACTIVE
type
enum<string>
Available options:
GRATUITY,
DISCOUNT
sortBy
enum<string>
default:name

Field to sort by

Available options:
code,
name,
createdAt
Example:

"name"

sortOrder
enum<string>
default:asc

Sort order

Available options:
asc,
desc
Example:

"asc"

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 benefit categories

data
object[]
required
meta
object
required