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 "List User Invites" retrieves a paginated list of user invites from an external service. It allows filtering by email and status, sorting the results, and controlling pagination through page number and size. This is useful in scenarios where you need to manage or audit user invitations sent out by your system, for example, to check which users have been invited but not yet accepted, or to generate reports on invite statuses.
Practical examples:
- Fetch all pending user invites to send reminder emails.
- Retrieve invites filtered by a specific email address to verify invitation status.
- List invites sorted by creation date to analyze recent activity.
Properties
| Name | Meaning |
|---|---|
| Filter invites by the invited user's email address. | |
| Status | Filter invites by their status. Accepts JSON array; e.g., pending, accepted, expired, etc. |
| Page Number | The page number of results to retrieve (starts at 1). |
| Page Size | Number of results per page (default 100, max 1000). |
| Sort By | Field to sort the results by (default is 'id'). |
| Sort Order | Sort direction: Asc (ascending) or Desc (descending). |
| Request Id | Optional client-generated identifier for tracing/debugging a single request (sent as header). |
| Correlation Id | Optional client-generated identifier for tracing/debugging a series of requests (header). |
Output
The node outputs JSON data representing the list of user invites matching the query parameters. Each item in the output typically includes details about the invite such as email, status, timestamps, and possibly metadata related to the invite.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the external Straddle API.
- The base URL for API requests is dynamically set based on the configured environment credential.
- The node sends HTTP requests with JSON content type and expects JSON responses.
Troubleshooting
- Empty results: Check that filters like email and status are correctly specified and match existing invites.
- Invalid page number or size: Ensure page number starts at 1 and page size does not exceed 1000.
- Authentication errors: Verify that the API key credential is valid and has necessary permissions.
- Rate limiting or network errors: May occur if too many requests are made; implement retries or backoff.
- Unexpected response structure: Confirm that the external API schema has not changed.
Links and References
- Straddle API Documentation (hypothetical link)
- n8n documentation on HTTP Request Node for understanding how API calls are made within nodes.