View as Markdown
Gorgias icon

Gorgias ACTION

List Macros

List all macros. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Gorgias account once, then configure and run List Macros 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: "gorgias_oauth-list-macros",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gorgias_oauth: { authProvisionId: "apn_xxxxxxx" },
    search: "Search",
    limit: 10,
  },
})

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.

List Macros inputs
Property Type Description
search Search string
Filter macros containing the given search query
Optional
limit Limit integer
Maximum number 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
gorgias_oauth-list-macros
Version
0.0.7
App
Gorgias
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes