View as Markdown
UpKeep icon

UpKeep ACTION

Find Location

Finds locations according to props configured, if no prop configured returns all locations, See the docs
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's UpKeep account once, then configure and run Find Location 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: "upkeep-find-location",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    upkeep: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    locationId: "Parent Location",
  },
})

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.

Find Location inputs
Property Type Description
name Name string
If set, the result will only include locations with that name.
Optional
locationId Parent Location string
If set, the result will only include sub locations of this parent location.
Optional Dynamic
createdByUser Created By User string
If set, the result will only include locations created by this user.
Optional 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
upkeep-find-location
Version
0.0.3
App
UpKeep
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes