List contacts - Automate.ax

jobNimbus.listContacts list JobNimbus contacts with offset pagination and filters.

automations/jobnimbus-list-contacts.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { jobNimbus } from "automate.ax/jobnimbus"

export default automation("List contacts", () => {
  onDashboardRun({ title: "List contacts" })
  jobNimbus.listContacts({ size: 100, from: 0, sortField: "dateCreated" })
})

Inputs

size defaults to 100 and accepts 1–1,000; from defaults to 0. Optional fields, Elasticsearch-style filter, sortField, sortDirection, and admin actor are supported. Optional second argument { account } selects a named JobNimbus binding.

Output

Returns { count, results: JobNimbusContact[] }. For more than 10,000 contacts, page by ascending creation date and deduplicate by ID as JobNimbus recommends.