List Benefit Programs - Documentação DEVMOB

{ "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 } }

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

Required range: 1 <= x <= 100

Example:

10

page

number

default:1

Page number

Required range: x >= 1

Example:

1

ownerType

enum<string>

Owner type.

Available options:

PLATFORM,

COMPANY

reviewOwnerType

enum<string>

Review owner type.

Available options:

PLATFORM,

COMPANY

status

enum<string>

Program status.

Available options:

ACTIVE,

INACTIVE

sortBy

enum<string>

default:priority

Field to sort by

Available options:

priority,

createdAt

Example:

"priority"

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

data

object[]

required

Show child attributes