Skip to main content
GET
List Benefit Requests

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>

Fare benefit category identifier

Example:

"0197f710-b826-77f0-a60b-6c62b9fdd301"

status
enum<string>

Benefit request status

Available options:
PENDING,
IN_REVIEW,
APPROVED,
REJECTED,
CANCELED,
EXPIRED
Example:

"PENDING"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
reviewedAt
Example:

"createdAt"

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 requests

data
object[]
required
meta
object
required