View as Markdown
Upsales icon

Upsales ACTION

Get Company

Retrieves a single company (account) by ID from Upsales. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Upsales account once, then configure and run Get Company 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: "upsales-get-company",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    upsales: { authProvisionId: "apn_xxxxxxx" },
    companyId: "Company ID",
  },
})

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 Company inputs
Property Type Description
companyId Company ID string
The company's unique ID. Use Get Company List to find an ID by name.
Required Dynamic

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
upsales-get-company
Version
0.0.1
App
Upsales
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes