Actions778
- Acl Role Actions
- App Actions
- App Action Button Actions
- App Administration Snippet Actions
- App Cms Block Actions
- App Flow Action Actions
- App Flow Event Actions
- App Payment Method Actions
- App Script Condition Actions
- App Shipping Method Actions
- App Template Actions
- Category Actions
- Cms Block Actions
- Cms Page Actions
- Cms Section Actions
- Cms Slot Actions
- Country Actions
- Country State Actions
- Currency Actions
- Currency Country Rounding Actions
- Custom Entity Actions
- Custom Field Actions
- Custom Field Set Actions
- Custom Field Set Relation Actions
- Customer Actions
- Customer Address Actions
- Customer Group Actions
- Customer Recovery Actions
- Customer Wishlist Actions
- Customer Wishlist Product Actions
- Delivery Time Actions
- Document Actions
- Document Base Config Actions
- Document Base Config Sales Channel Actions
- Document Type Actions
- Flow Actions
- Flow Sequence Actions
- Flow Template Actions
- Import Export File Actions
- Import Export Log Actions
- Import Export Profile Actions
- Integration Actions
- Landing Page Actions
- Language Actions
- Locale Actions
- Log Entry Actions
- Mail Header Footer Actions
- Mail Template Actions
- Mail Template Type Actions
- Main Category Actions
- Media Actions
- Media Default Folder Actions
- Media Folder Actions
- Media Folder Configuration Actions
- Media Thumbnail Actions
- Media Thumbnail Size Actions
- Newsletter Recipient Actions
- Notification Actions
- Number Range Actions
- Number Range Sales Channel Actions
- Number Range State Actions
- Number Range Type Actions
- Order Actions
- Order Customer Actions
- Order Delivery Actions
- Order Delivery Position Actions
- Order Line Item Actions
- Order Line Item Download Actions
- Order Transaction Actions
- Order Transaction Capture Actions
- Order Transaction Capture Refund Actions
- Order Transaction Capture Refund Position Actions
- Payment Method Actions
- Plugin Actions
- Product Actions
- Product Configurator Setting Actions
- Product Cross Selling Actions
- Product Cross Selling Assigned Products Actions
- Product Download Actions
- Product Export Actions
- Product Feature Set Actions
- Product Keyword Dictionary Actions
- Product Manufacturer Actions
- Product Media Actions
- Product Price Actions
- Product Review Actions
- Product Search Config Actions
- Product Search Config Field Actions
- Product Search Keyword Actions
- Product Sorting Actions
- Product Stream Actions
- Product Stream Filter Actions
- Product Visibility Actions
- Promotion Actions
- Promotion Discount Actions
- Promotion Discount Prices Actions
- Promotion Individual Code Actions
- Promotion Sales Channel Actions
- Promotion Setgroup Actions
- Property Group Actions
- Property Group Option Actions
- Rule Actions
- Rule Condition Actions
- Sales Channel Actions
- Sales Channel Analytics Actions
- Sales Channel Domain Actions
- Sales Channel Type Actions
- Salutation Actions
- Scheduled Task Actions
- State Machine Transition Actions
- System Config Actions
- Tag Actions
- Tax Actions
- Tax Provider Actions
- Tax Rule Actions
- Tax Rule Type Actions
- Theme Actions
- Unit Actions
- User Actions
- User Access Key Actions
- User Config Actions
- User Recovery Actions
- Webhook Actions
- Webhook Event Log Actions
- System Info Health Check Actions
- Bulk Operations Actions
- Document Management Actions
- Asset Management Actions
- Mail Operations Actions
- System Operations Actions
- Customer Impersonation Actions
- Order Management Actions
- Order Address Actions
- Authorization Authentication Actions
Newsletter Recipient → Get Newsletter Recipient List
AI-generatedOverview
This node operation retrieves a list of newsletter recipients from the Shopware platform. It is useful for scenarios where you need to fetch and manage newsletter subscriber data, such as for marketing campaigns, data analysis, or synchronization with other systems. For example, you can use it to get a paginated list of recipients with optional filtering using a SwagQL query.
Use Case Examples
- Fetch the first 50 newsletter recipients to display in a dashboard.
- Retrieve a specific page of newsletter recipients for batch processing.
- Use a SwagQL query to filter recipients based on subscription status or other criteria.
Properties
| Name | Meaning |
|---|---|
| Limit | Maximum number of newsletter recipient resources to be returned in a single page. |
| Page | The page number of the newsletter recipient list to be returned. |
| Query | Encoded SwagQL query in JSON format to filter or customize the list of newsletter recipients. |
| Request Options | Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout. |
Output
JSON
recipients- Array of newsletter recipient objects returned from the API.total- Total number of newsletter recipients available matching the query.page- Current page number of the returned list.limit- Maximum number of recipients returned per page.
Dependencies
- Shopware platform API
- An API key credential for authentication
Troubleshooting
- Ensure the API credentials are correctly configured and have the necessary permissions to access newsletter recipient data.
- Check that the 'limit' and 'page' parameters are set to valid numbers to avoid request errors.
- If using a custom SwagQL query, verify the query syntax and encoding to prevent API errors.
- If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
- Network issues or proxy misconfiguration can cause request failures; verify proxy settings if used.