Skip to main content
GET
List Benefit Usage History

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

fareBenefitCategoryId
string<uuid> | null

Fare benefit category identifier

Example:

null

status
enum<string>

Benefit usage status

Available options:
APPLIED,
REVERSED
Example:

"APPLIED"

sortBy
enum<string>
default:usedAt

Field to sort by

Available options:
usedAt,
createdAt
Example:

"usedAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

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 usage history

data
object[]
required
meta
object
required