@mbanq/core-sdk-js / commands / GetSubscriptions
Function: GetSubscriptions()
GetSubscriptions(
params):Command<{params: {limit?:number;offset?:number;orderBy?:"id";sortOrder?:"ASC"|"DESC";subscriberId:number; }; }, {pageItems:object[];totalFilteredRecords:number; }>
Defined in: src/commands/rest/notification.ts:442
Retrieves a list of all subscriptions with optional filtering and pagination.
Parameters
params
Query parameters for filtering, pagination, and sorting
limit?
number = ...
Maximum number of records to return. Set to 0 to fetch all records
offset?
number = ...
Pagination offset (number of records to skip)
orderBy?
"id" = ...
Field to order results by. Values: id
sortOrder?
"ASC" | "DESC" = ...
Sort order direction. Values: ASC, DESC
subscriberId
number = ...
The ID of the subscriber
Returns
Command<{ params: { limit?: number; offset?: number; orderBy?: "id"; sortOrder?: "ASC" | "DESC"; subscriberId: number; }; }, { pageItems: object[]; totalFilteredRecords: number; }>
A Command that when executed returns the list of subscriptions
Example
const getSubscriptionsCmd = GetSubscriptions({
subscriberId: 123,
offset: 0,
limit: 10,
orderBy: 'id',
sortOrder: 'ASC'
});
const result = await getSubscriptionsCmd.execute(config);
console.log(result.pageItems);