View as Markdown
Mautic icon

Mautic ACTION

Search Contacts

Gets a list of contacts by a search term. See docs
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mautic account once, then configure and run Search Contacts from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "mautic-search-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mautic: { authProvisionId: "apn_xxxxxxx" },
    search: "Search Query",
    orderBy: "Order By",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search Contacts inputs
Property Type Description
search Search Query string
String or search command to filter entities by
Required
orderBy Order By string
Column to sort by. Can use any column listed in the response in snake_case
Optional
orderByDir Order By Direction string
Sort direction: ascending or descending
Optional
publishedOnly Is Published Only boolean
Only return currently published entities
Optional
minimal Minimal boolean
Return only array of entities without additional lists in it
Optional
where Where any
An array of advanced where conditions
Optional
order Order any
An array of advanced order statements
Optional
maxResults Max Results integer
Limit number of entities to return
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
mautic-search-contacts
Version
0.2.1
App
Mautic
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes