Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / ListCampaignsParams

Interface: ListCampaignsParams

Defined in: client/src/resources/campaigns/campaigns.types.ts:344

Parameters for CampaignsClient.listCampaigns and the auto-pagination helpers (CampaignsClient.iterateCampaigns, CampaignsClient.iterateCampaignsPages, CampaignsClient.listAllCampaigns).

Example ​

typescript
// List email campaigns, page 2
const page = await client.campaigns.listCampaigns({
  filters: { messageType: 'email' },
  pagination: { page: 2, pageSize: 20 },
});

Properties ​

filters? ​

optional filters?: object

Defined in: client/src/resources/campaigns/campaigns.types.ts:346

messageType? ​

optional messageType?: CampaignMessageType

Filter by message type.

'email' = email campaigns, 'text_message' = SMS campaigns.

pagination? ​

optional pagination?: PagePaginationParams

Defined in: client/src/resources/campaigns/campaigns.types.ts:345