Straddle icon

Straddle

Interact with Straddle API
Join our community

Actions81

Overview

This node operation retrieves a list of customers from the Straddle API with various filtering, sorting, and pagination options. It is useful for workflows that need to query customer data, such as generating reports, syncing customer information with other systems, or triggering actions based on customer attributes.

Typical use cases include:

  • Fetching paginated customer lists for display or processing.
  • Filtering customers by creation date, status, type, or identifiers.
  • Sorting customers by name or creation date in ascending or descending order.
  • Searching customers by general text or specific fields like email or external ID.

Properties

Name Meaning
Page Number Page number for paginated results. Starts at 1. Default: 1.
Page Size Number of results per page. Default: 100. Maximum: 1000.
Sort By Field to sort results by. Options: Name, Created At
Sort Order Sort direction. Options: Asc (ascending), Desc (descending)
Created From Start date filter for customer creation date
Created To End date filter for customer creation date
Name Filter customers by partial match on their name
External Id Filter by your system's customer identifier
Email Filter customers by email address
Status Filter customers by their current status (JSON array expected)
Search Text General search term to filter customers
Types Filter by customer type; possible values are 'individual' or 'business' (JSON array expected)
Straddle Account Id Header to specify an account id and set scope of the request (for platform use)
Request Id Optional client-generated identifier to trace and debug a request (header)
Correlation Id Optional client-generated identifier to trace and debug a series of requests (header)

Output

The node outputs JSON data containing the retrieved customer records matching the specified filters and pagination. The structure corresponds to the API response schema for customers, which typically includes customer details such as:

  • Identifiers (e.g., customer ID, external ID)
  • Personal or business information (name, email, type)
  • Status and verification details
  • Creation timestamps
  • Additional metadata as provided by the API

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Straddle API.
  • The base URL for API requests depends on the configured environment credential parameter.
  • The node uses standard HTTP headers including Accept: application/json and Content-Type: application/json.
  • Optional custom headers can be set for account scoping and request tracing.

Troubleshooting

  • Empty or no results: Check that the filter parameters are correctly set and that the page number and size are within valid ranges.
  • Authentication errors: Ensure the API key credential is valid and has appropriate permissions.
  • Invalid date formats: The created_from and created_to properties expect string dates; ensure they follow the expected format (usually ISO 8601).
  • Malformed JSON inputs: For properties expecting JSON arrays (like status and types), ensure the input is valid JSON.
  • Rate limiting or API errors: Monitor error messages returned by the API and handle retries or backoff accordingly.

Links and References

Discussion