Actions20
- Claim (Case Management API) Actions
- Debtor (Case Management API) Actions
- Info (Case Management API) Actions
- Company (Partner API) Actions
- User (Partner API) Actions
- User Invite (Partner API) Actions
Overview
This node integrates with the Paywise Partner API to manage users. Specifically, the User - List operation retrieves a list of users filtered by various criteria such as user ID, email, first name, last name, or company ID. It supports pagination through limit and offset parameters.
Typical use cases include:
- Fetching users matching specific attributes for reporting or synchronization.
- Retrieving paginated user lists to display in dashboards or admin panels.
- Filtering users by company association to manage access or permissions.
Properties
| Name | Meaning |
|---|---|
| Filters | A collection of optional filters to narrow down the user list: |
| - User ID: Filter by user UUID | |
| - Email: Filter by email address | |
| - First Name: Filter by first name | |
| - Last Name: Filter by last name | |
| - Company ID: Filter by company UUID | |
| Limit | Number of results to return per page (minimum 1, maximum 100) |
| Offset | The initial index from which to return the results (used for pagination) |
Output
The output is an array of JSON objects, each representing a user that matches the specified filters. Each item contains user data fields as returned by the Paywise Partner API's user listing endpoint.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Paywise API.
- The node depends on the Paywise Partner API being accessible and properly configured.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Using filters with incorrect UUID formats may result in no data returned or errors.
- Requesting a limit outside the allowed range (less than 1 or greater than 100) may cause validation errors.
- Network connectivity issues can prevent successful API calls.
Error messages:
"Resource "user" is not implemented": Indicates the resource parameter was set incorrectly or the node does not support it."Operation "list" for resource "user" is not implemented": Means the operation parameter is invalid or unsupported.- API error responses typically relay issues like unauthorized access or invalid parameters; ensure credentials and inputs are correct.
Links and References
- Paywise API Documentation
- Refer to the official Paywise Partner API docs for detailed information on user resource endpoints and filtering options.