Actions81
- Users Actions
- Organizations Actions
- Representatives Actions
- Bridge Actions
- Platforms Actions
- Tools Actions
- User Invites Actions
- Customers Actions
- Paykeys Actions
- Reports Actions
- Charge Actions
- Funding Events Actions
- Payments Actions
- Payout Actions
- Accounts Actions
- Get Account By Id
- put__v1_accounts_account_id
- Create Account
- get__v1_accounts
- post__v1_accounts_account_id_onboard
- post__v1_accounts_account_id_simulate
- patch__v1_internal_accounts_account_id
- get__v1_internal_accounts_account_id
- patch__v1_internal_accounts_account_id_status
- get__v1_internal_accounts_account_id_settings
- Capability Requests Actions
- Linked Bank Accounts Actions
Overview
This node operation retrieves a list of users from an external service, supporting various filters and pagination options. It is useful in scenarios where you need to query user data based on specific criteria such as name, email, status, or user level, and control the amount and order of data returned.
Practical examples include:
- Fetching all active users with a certain email domain.
- Searching users by partial name matches for reporting or auditing.
- Paginating through large user datasets while sorting by user ID.
Properties
| Name | Meaning |
|---|---|
| Name | Filter users by name (supports partial match). |
| Filter users by exact email address. | |
| Status | Filter users by their status. |
| Search Text | General search term to filter users across multiple fields. |
| User Level | Filter users by their user level. |
| Page Number | Results page number to retrieve; starts at 1. Default is 1. |
| Page Size | Number of results per page; default is 100, maximum is 1000. |
| Sort By | Field to sort results by; default is 'id'. |
| Sort Order | Sort direction: Ascending ("asc") or Descending ("desc"). |
| Request Id | Optional client-generated identifier to trace and debug a single request (sent as header). |
| Correlation Id | Optional client-generated identifier to trace and debug a series of requests (sent as header). |
Output
The node outputs JSON data containing the list of users matching the specified filters and pagination settings. Each user object includes detailed information such as:
- Metadata and device info (IP address, user agent).
- Address and compliance profile details.
- Capabilities and settings related to payments and customer types.
- Industry and support contact information.
- Bank account and verification status details.
- Status messages and timestamps for changes.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authentication with the external user service.
- The base URL for API requests is dynamically constructed based on the configured environment.
- Standard HTTP headers for JSON content are set automatically.
Troubleshooting
- Empty results: Check that filter values are correct and that the page number and size are within valid ranges.
- Invalid credentials or authentication errors: Ensure the API key credential is correctly configured and has necessary permissions.
- Rate limiting or request failures: Use the optional Request Id and Correlation Id headers to trace and debug requests with the API provider.
- Sorting or pagination issues: Verify that the "Sort By" field exists and that "Page Number" and "Page Size" are positive integers within allowed limits.
Links and References
- No direct links provided in the source code.
- For more details, consult the external API documentation corresponding to the user service this node interacts with.