Interface GetBenefitsQuery

Query parameters for sb.benefits.list().

interface GetBenefitsQuery {
    categoryRef?: string;
    featured?: boolean;
    limit?: number;
    locationRef?: string;
    nextPageToken?: string;
}

Properties

categoryRef?: string

UUID of the benefit category.

featured?: boolean

Filter by featured status. Pass true or false.

limit?: number

Maximum number of benefits per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

locationRef?: string

UUID of the location.

nextPageToken?: string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.