Kajabi icon

Kajabi

Interact with Kajabi API to manage contacts, customers, offers, courses, purchases, orders and more

Actions64

Customer → Get Many

AI-generated

Summary

Retrieve multiple customers from Kajabi with optional pagination, sorting, filtering, and inclusion of related resources.

Inputs

  • Authentication (required) — Choose between OAuth2 or API Key methods to authenticate with the Kajabi API.
  • Return All — Enable to fetch all customer records, otherwise limited to the specified limit.
  • Limit — Maximum number of customers to retrieve when Return All is false; minimum value is 1.
  • Page — Page number to retrieve starting at 1, used only when Return All is false.
  • Sort — Comma-separated list of fields to sort by, prefix with '-' for descending order (e.g., '-created_at,name').
  • Sparse Fields — Comma-separated list of customer attributes to return, reducing payload size; leave empty to return all fields.
  • Include — Related resources to include in the response, such as Site, Contact, and Products.
  • Filters — Collection of filter criteria to narrow down the customer search, such as email contents, offer ID, product ID, tag ID, subscription status, creation dates, and more.

Output shape

a list of customer records

The response contains customer objects under the 'data' property. Supports automatic pagination when Return All is enabled; otherwise, returns a single page with up to the Limit number of customers.

Links

Discussion