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 paginated list of accounts from an external API. It allows users to specify sorting and pagination parameters to control the order and size of the returned account data. This is useful in scenarios where you need to fetch multiple account records for reporting, synchronization, or further processing within an automation workflow.
Practical examples include:
- Fetching all accounts page by page to sync with a CRM system.
- Retrieving accounts sorted by creation date or name for display or analysis.
- Debugging or tracing requests using optional request and correlation IDs.
Properties
| Name | Meaning |
|---|---|
| Sort By | Field name to sort the results by (string). |
| Page Number | Results page number to retrieve. Starts at 1. Default is 1. |
| Page Size | Number of results per page. Default is 100, maximum allowed is 1000. |
| Sort Order | Order of sorting: "asc" (ascending) or "desc" (descending). Default is "asc". |
| Request Id | Optional client-generated identifier to trace and debug a single request (string). |
| Correlation Id | Optional client-generated identifier to trace and debug a series of related requests (string). |
Output
The output JSON contains an array of account objects representing the retrieved accounts. Each account object includes detailed information such as:
- Business profile (address, industry, support channels)
- Capabilities (supported payment types and customer types)
- Settings (charge and payout configurations)
- Bank details and verification status
- Status details including messages and timestamps
- Compliance and representative information if applicable
The structure is rich and nested, reflecting comprehensive account data suitable for detailed processing or display.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authentication to the external service.
- The base URL for API requests is dynamically set based on the configured environment.
- The node expects standard HTTP headers including
AcceptandContent-Typeset toapplication/json. - Optional headers for request tracing (
request-idandcorrelation-id) can be provided.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Requesting a page number beyond available pages may return empty results.
- Exceeding the maximum page size (1000) might result in errors or truncated responses.
- Incorrect field names in "Sort By" may lead to unexpected sorting behavior or API errors.
Error messages:
- Authentication errors typically indicate invalid or expired API keys; verify credentials.
- Validation errors on query parameters suggest incorrect values for pagination or sorting; check input values.
- Network or timeout errors require checking connectivity and API availability.
Links and References
- Refer to the external API documentation for detailed descriptions of account fields and supported query parameters.
- Use the API provider’s guidelines for generating and managing API keys and environment setup.
- For debugging, consult the API's tracing and logging features using the
request-idandcorrelation-idheaders.