View as Markdown
Belco icon

Belco ACTION

List Contacts

List the contacts of a Belco shop, optionally filtered by email address, phone number or contact type. Use this to look up a recipient's contact ID by email before calling Create Conversation, Send Message or Get Contact Details — or skip the lookup entirely by passing To Email to Create Conversation / Send Message. Use List Shop ID Options to find the shop ID. Paginate with Limit and Skip. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Belco account once, then configure and run List 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: "belco-list-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    belco: { authProvisionId: "apn_xxxxxxx" },
    shopId: "Shop ID",
    email: "Email",
  },
})

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 Contacts inputs
Property Type Description
shopId Shop ID string
The ID of the Belco shop, e.g. QCKysMML2DRfxW37G. Use List Shop ID Options to find it (the value field).
Required Dynamic
email Email string
Only return contacts with this email address (e.g. jane@example.com).
Optional
phoneNumber Phone Number string
Only return contacts with this phone number, in E.164 format (e.g. +31612345678).
Optional
contactType Contact Type string
Only return contacts of this type.
Optional
limit Limit integer
Maximum number of contacts to return.
Optional
skip Skip integer
Number of contacts to skip, for pagination (e.g. 50 for the second page when Limit is 50).
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
belco-list-contacts
Version
0.0.1
App
Belco
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes