View as Markdown
Z-API icon

Z-API ACTION

Get Contacts

Get a list of all your WhatsApp contacts. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Z-API account once, then configure and run Get 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: "z_api-get-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    z_api: { authProvisionId: "apn_xxxxxxx" },
    pageNum: "Page",
    pageSize: "Page Size",
  },
})

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.

Get Contacts inputs
Property Type Description
pageNum Page string
Used to paginate the results
Required
pageSize Page Size string
The number of chats to be retrieved
Required

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
z_api-get-contacts
Version
0.0.2
App
Z-API
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes