Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node operation retrieves a list of organizations from an external service, supporting filtering, pagination, and sorting. It is useful when you need to query organizational data based on partial or exact matches for organization name or external ID, and control the amount and order of results returned.

Common scenarios include:

  • Fetching organizations matching a specific name pattern for reporting or integration.
  • Retrieving organizations by their external identifiers to synchronize data.
  • Paginating through large sets of organizations in batches.
  • Sorting organizations by different fields in ascending or descending order.

Example use case: You want to get the first 100 organizations whose names contain "Tech" sorted by their IDs ascending, to display them in a dashboard or process them further.

Properties

Name Meaning
Name Filter organizations by name (supports partial match).
External Id Filter organizations by their external ID.
Page Number Results page number to retrieve; starts at 1. Default is 1.
Page Size Number of results per page; default 100, maximum 1000.
Sort By Field to sort results by; default is 'id'.
Sort Order Sort direction; options are Asc (ascending) or Desc (descending).
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 output JSON contains the list of organizations retrieved according to the specified filters, pagination, and sorting. Each organization object includes detailed information such as business profile, capabilities, settings, representative details, bank account info, status, verification, and support channels.

The structure reflects rich metadata about each organization, including nested objects for address, compliance, industry, payment capabilities, and more.

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 depends on the configured environment credential parameter.
  • The node sends HTTP requests with JSON content type and expects JSON responses.

Troubleshooting

  • Empty results: Check that filter parameters like Name or External Id are correct and that the page number and size are within valid ranges.
  • Authentication errors: Ensure the API key credential is correctly configured and has necessary permissions.
  • Rate limiting or quota errors: If many requests are made rapidly, the API might throttle; consider adding delays or handling retries.
  • Invalid sort field or order: Use supported values for "Sort By" and "Sort Order" properties to avoid errors.
  • Header tracing IDs not working: Verify that "Request Id" and "Correlation Id" headers are unique strings if used for debugging.

Links and References

Discussion