FlexPoint icon

FlexPoint

Interact with FlexPoint API

Customers → Get Customers

AI-generated

Summary

Retrieve a list of customers from the FlexPoint API, optionally filtering and paginating the results.

Inputs

  • Return All — Choose whether to retrieve all customers or just a single page of results. When false, only one page is returned without pagination parameters.
  • Additional Fields — Optional query parameters to filter and control the response, including search term, parent customer ID, whether to include added child customers, offset for pagination, page size, and external URI.
  • Options — Additional customization options including custom JSON body overrides, custom HTTP headers, query string filters, batching settings (items per batch and interval between batches), debug mode to include request details in output, pagination settings to control how pages are fetched, and request timeout in milliseconds.

Output shape

a list of customer records returned as JSON objects, each item representing one customer; may include pagination metadata or debug information if enabled.

If 'Return All' is enabled, this operation paginates through and returns all matching customer records according to the supplied pagination settings. Otherwise, only a single page of results is returned based on the specified offset and page size. Enabling debug mode will include detailed HTTP request/response information in the output for troubleshooting. Custom headers and query filters can modify the API request. The response data path and pagination mode can be configured to accommodate API behavior.

Links

Discussion