View as Markdown
Loyverse icon

Loyverse ACTION

Get Customer(s)

Retrieves details of one or more customers. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Loyverse account once, then configure and run Get Customer(s) 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: "loyverse-get-customer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    loyverse: { authProvisionId: "apn_xxxxxxx" },
    customerId: "Customer ID",
    customerAmount: 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.

Get Customer(s) inputs
Property Type Description
customerId Customer ID string
Select a customer or provide a customer ID to retrieve information for. You can leave this empty to retrieve a list of customers instead.
Optional Dynamic
customerAmount Max Amount integer
The maximum amount of customers you want to retrieve, starting from the most recent customers. If you provide a Customer ID, this will be ignored.
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
loyverse-get-customer
Version
0.0.2
App
Loyverse
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes