View as Markdown
Xero Accounting icon

Xero Accounting ACTION

List Contacts

Lists information from contacts in the given tenant id as per filter parameters.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Xero Accounting 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: "xero_accounting_api-list-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    xero_accounting_api: { authProvisionId: "apn_xxxxxxx" },
    tenantId: "Tenant ID",
    modifiedAfter: "Modified After",
  },
})

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
tenantId Tenant ID string
Select an organization tenant to use, or provide a tenant ID
Required Dynamic
modifiedAfter Modified After string
Filter by a date. Only contacts modified since this date will be returned. Format: YYYY-MM-DD
Optional
ids IDs string
Filter by a comma-separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. See details.
Optional
where Where string
Filter using the where parameter. We recommend you limit filtering to the optimised elements only.
Optional
order Order string
Order by any element returned (see Order By.)
Optional
page Page string
Up to 100 contacts will be returned per call when the page parameter is used e.g. page=1.
Optional
includeArchived Include Archived boolean
e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response.
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
xero_accounting_api-list-contacts
Version
0.2.2
App
Xero Accounting
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes