Skip to main content
GET
/
api
/
v1
/
customer
/
benefits
/
requests
List Benefit Requests
curl --request GET \
  --url https://api.example.com/api/v1/customer/benefits/requests \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/v1/customer/benefits/requests"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/customer/benefits/requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/customer/benefits/requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/customer/benefits/requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/customer/benefits/requests")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/customer/benefits/requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "passengerBenefitRequestId": "0197f712-8a7e-7a53-9d28-51f8f3c77d41",
      "customerId": "0197a7f6-4d36-7c0a-a7cb-54fcb33a3148",
      "fareBenefitCategoryId": "0197f710-b826-77f0-a60b-6c62b9fdd301",
      "requestedByUserId": "0197a7f6-2c4d-74ae-b89b-9d36d9c341f2",
      "code": "BEN-20260704-0001",
      "status": "PENDING",
      "createdAt": "2026-07-04T11:30:00.000Z",
      "updatedAt": "2026-07-04T12:00:00.000Z",
      "reviewedByUserId": null,
      "notes": "Student half-fare request",
      "rejectionReason": null,
      "createdBy": null,
      "updatedBy": null,
      "deletedBy": null,
      "deletedAt": null,
      "reviewedAt": null,
      "validFrom": null,
      "validUntil": null
    }
  ],
  "meta": {
    "limit": 10,
    "page": 1,
    "totalItems": 100,
    "totalPages": 10
  }
}
{
  "errors": [
    {
      "message": "required",
      "path": "name"
    }
  ],
  "message": "Bad Request Error",
  "statusCode": 400
}
{
  "message": "Missing or invalid access token",
  "statusCode": 401
}
{
  "message": "Internal Server Error",
  "statusCode": 500
}

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