n8n-nodes-base/dist/node-definitions/nodes/n8n-nodes-base/convertKit/v1/resource_sequence/operation_get_subscriptions.ts

Base nodes of n8n

/**
 * ConvertKit Node - Version 1
 * Discriminator: resource=sequence, operation=getSubscriptions
 */


interface Credentials {
  convertKitApi: CredentialReference;
}

/** List subscriptions to a form including subscriber data */
export type ConvertKitV1SequenceGetSubscriptionsParams = {
  resource: 'sequence';
  operation: 'getSubscriptions';
/**
 * Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>
 */
    id?: string | Expression<string>;
/**
 * Whether to return all results or only up to a given limit
 * @default false
 */
    returnAll?: boolean | Expression<boolean>;
/**
 * Max number of results to return
 * @displayOptions.show { returnAll: [false] }
 * @default 100
 */
    limit?: number | Expression<number>;
/**
 * Receive only active subscribers or cancelled subscribers
 * @default {}
 */
    additionalFields?: {
    /** Subscriber State
     * @default active
     */
    subscriberState?: 'active' | 'cancelled' | Expression<string>;
  };
};

export type ConvertKitV1SequenceGetSubscriptionsNode = {
  type: 'n8n-nodes-base.convertKit';
  version: 1;
  credentials?: Credentials;
  config: NodeConfig<ConvertKitV1SequenceGetSubscriptionsParams>;
};