Follow Up Boss icon

Follow Up Boss

Interact with the Follow Up Boss API

Actions148

Email Marketing Event → Get Many

AI-generated

Summary

Retrieve email marketing events with filtering, sorting, and pagination controls.

Inputs

  • authentication — Authentication method for API access. Defaults to API Key; OAuth2 also supported.
  • returnAll — Boolean. When false, limits results to the specified limit value; when true, returns all available results subject to platform paging.
  • limit — Positive integer. Maximum number of results to return. Only active when returnAll is false. Defaults to 50.
  • options.createdAfter — Datetime. Filter records created after the specified date/time.
  • options.createdBefore — Datetime. Filter records created before the specified date/time.
  • options.idGreaterThan — Integer. Filter records with an ID greater than the given value.
  • options.idLessThan — Integer. Filter records with an ID less than the given value.
  • options.ids — String (comma-separated). Retrieve a specific list of email marketing event IDs, e.g., '1,2,3'.
  • options.personId — ResourceLocator. Find events by person. Supports selecting by ID, by URL, or from a list picker.
  • options.sort.field — String. The field to sort results by (default: 'created').
  • options.sort.direction — Options: 'asc' or 'desc'. Direction to sort results in (default: 'desc').

Output shape

paginated list of email marketing event objects as returned by the Follow Up Boss API.

Pagination is handled server-side via the transport layer; use returnAll and limit to control scope.

Links

Discussion