List contacts - Automate.ax

listContacts returns a bounded page from the account-wide contact collection.

Example

import { automation, onHttpRequest } from "automate.ax"
import { listContacts } from "automate.ax/brevo"

export default automation("List recent customers", () => {
  onHttpRequest({ scope: "automation" })

  listContacts({ lists: ["Customers"], limit: 250, sort: "desc" })
})

Inputs

limit defaults to 50 (maximum 1,000), offset to 0, and sort to desc. Optional filters are RFC 3339 createdSince and modifiedSince, Brevo attribute filter expression, up to 20 positive contact ids, list names/IDs, or positive segmentId. Lists and segment cannot be combined. account selects the Brevo binding.

Output

Returns { count: number; contacts: Contact[] }; see Get contact. count is the matching total. Increment offset by the number returned to page through results. List names require an additional complete list-name resolution before the contact query.

⌘I