Skip to main content

getFormSubscriptions

Get all form subscriptions. 🔐 This method requires .

Description​

This method returns all of the current user's form subscriptions. It returns a Promise that resolves to an IFormSubscriptionsResponse object - a container with items (the IListFormSubscription entries) and total - not a bare array.

.getFormSubscriptions(

,

);

Parameters schema​

Schema

offset: number
Optional offset for pagination. Default: 0
example: 0

limit: number
Optional limit for pagination. Default: 30
example: 30

By default, you can retrieve 10 objects. This is due to the record limit in the module's permissions settings.
For pagination to work correctly, you need to configure Module permissions (opens in a new tab) according to your needs in the corresponding section.*

Examples​

Minimal example​

const response = await Events.getFormSubscriptions();

Example with attributes​

const response = await Events.getFormSubscriptions(0, 30);

Example response​

{
  "total": 0,
  "items": []
}

Response schema​

Schema: IFormSubscriptionsResponse

items: IListFormSubscription[]
Array of form subscriptions.

items.eventMarker: string
Event marker.
example: "form_marker"

items.formDataId: number
Form data identifier.
example: 123

total: number
Total number of subscriptions.
example: 0