Actions12
Overview
The "List Users" operation of the Memberspot node retrieves a paginated list of users from the Memberspot platform. It supports filtering users by their active status, associated course ID, or offer ID. This operation is useful for scenarios where you need to manage or analyze user data in bulk, such as generating reports on active/inactive users, segmenting users by courses or offers they are enrolled in, or synchronizing user lists with other systems.
Practical examples:
- Fetch all active users enrolled in a specific course to send targeted communications.
- Retrieve users filtered by a particular offer to analyze offer uptake.
- Paginate through large user lists efficiently using the "Last Loaded ID" and "Page Length" options.
Properties
| Name | Meaning |
|---|---|
| Additional Options | Collection of optional filters and pagination controls: |
| - Active Filter | Filter users by status: All, Active Only, or Inactive Only |
| - Filter by Course ID | Filter users enrolled in a specific course by providing the course ID |
| - Filter by Offer Name or ID | Filter users associated with a specific offer, selectable from a list or via expression |
| - Last Loaded ID | Identifier for pagination to continue loading from a specific page (from previous response) |
| - Page Length | Number of user items to retrieve per page |
Output
The output is an array of JSON objects representing users matching the specified filters and pagination settings. Each item contains user details as returned by the Memberspot API's /v1/users/list endpoint. The exact structure depends on the API response but typically includes user identifiers, names, email addresses, status, and related metadata.
No binary data is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Memberspot API.
- The node makes HTTP requests to the Memberspot REST API endpoints.
- Proper configuration of the Memberspot API base URL and API key is necessary in the node credentials.
Troubleshooting
Common issues:
- Invalid or missing API key will cause authentication failures.
- Incorrect filter values (e.g., invalid course or offer IDs) may result in empty responses or errors.
- Pagination parameters must be used carefully; incorrect
Last Loaded IDcan lead to repeated or skipped data.
Error messages:
- Errors from the API are caught and reported. If "Continue On Fail" is enabled, errors for individual items return an error message in the output JSON.
- Typical errors include network issues, unauthorized access, or invalid parameters.
Resolution tips:
- Verify API credentials and permissions.
- Confirm that filter values correspond to existing courses or offers.
- Use the "Last Loaded ID" only as provided by the previous response's pagination info.
Links and References
- Memberspot API Documentation (general reference for API endpoints)
- n8n Expressions Documentation (for dynamic input expressions)