Regulars icon

Regulars

Interact with the Regulars public API

Guest → Get Many

AI-generated

Summary

Retrieves guests from the Regulars API, with pagination, optional filters, and sorting.

Inputs

  • Page — Page number for pagination (default 0).
  • Limit — Maximum results per page (default 50).
  • Card Page ID — Optionally filter guests by card page.
  • Email — Optionally filter by email address.
  • Phone — Optionally filter by phone number.
  • Pay IDs JSON — JSON array of Pay IDs to filter by (default []).
  • UTMs JSON — JSON array of UTMs to filter by (default []).
  • Sort By — Sort field: Created At, Updated At, Name, or Email (default Created At).
  • Sort Direction — Ascending or Descending order (default Descending).

Output shape

A list of n8n items, generally one per returned guest.

Guest records are returned as JSON. Array responses are expanded into individual items; a single object response becomes one item. Requires Regulars OAuth2 credentials.

Links

Discussion