Skip to main content
GET
/
api
/
v1
/
bko
/
benefit-programs
List Benefit Programs
curl --request GET \
  --url https://api.example.com/api/v1/bko/benefit-programs
{
  "data": [
    {
      "fareBenefitProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fareBenefitCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "name": "<string>",
      "description": "<string>",
      "discountValue": 123,
      "maxDiscountAmount": 123,
      "priority": 123,
      "cumulative": true,
      "startsAt": "2023-11-07T05:31:56Z",
      "endsAt": "2023-11-07T05:31:56Z",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 125,
    "totalPages": 7
  }
}

Query Parameters

​
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.

​
page
number
default:1

Page number.

​
pageSize
number
default:20

Items per page.

​
sort
string

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

​
search
string

Search by code or name.

​
status
enum<string>

Filter by program status.

Available options:
ACTIVE,
INACTIVE
​
fareBenefitCategoryId
string<uuid>

Filter by category identifier.

Response

OK

​
data
object[]
required
​
meta
object
required

Pagination metadata