ScalePad icon

ScalePad

Interact with ScalePad Core API and Lifecycle Manager

Client → Get Many

AI-generated

Summary

Retrieves a list of ScalePad clients based on optional filtering and sorting.

Inputs

  • returnAll — Whether to retrieve all available client records or only a subset.
  • limit — The maximum number of results to return. Only applies when returnAll is false.
  • additionalFields — Optional filtering and sorting configuration. Use the 'Filter' option to add criteria (e.g., status, created date) and the 'Sort' option to order results by field.

Output shape

a list of items

If returnAll is false, the limit parameter caps the results. Pagination is handled automatically when returnAll is true.

Examples

Example 1: List clients with a status filter

Set returnAll to true and add a filter for status (e.g., field: Status, operator: Equals, value: Active).

Example 2: Retrieve top 10 clients sorted by name

Set returnAll to false and limit to 10. Add a sort by name in Ascending order.

Example 3: Get all clients created after a specific date

Set returnAll to true. Add a filter with field: Created At, operator: Greater Than, and the target date.

Links

Discussion