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": { "limit": 10, "page": 1, "totalItems": 142, "totalPages": 15 } }

Query Parameters

limit

number

default:10

Items per page.

Required range: 1 <= x <= 100

page

number

default:1

Page number.

Required range: x >= 1

filter

string

Text search filter.

companyId

string<uuid>

Company identifier.

routeId

string<uuid>

Route identifier.

status

enum<string>

Program status.

Available options:

ACTIVE,

INACTIVE

sortBy

enum<string>

default:priority

Field to sort by.

Available options:

priority,

name,

createdAt

sortOrder

enum<string>

default:asc

Sort direction.

Available options:

asc,

desc

fields

string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

data

object[]

required

Show child attributes