View as Markdown
HighLevel icon

HighLevel ACTION

List Businesses

Retrieves all businesses for a location in HighLevel. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HighLevel account once, then configure and run List Businesses 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: "highlevel_oauth-list-businesses",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    highlevel_oauth: { authProvisionId: "apn_xxxxxxx" },
    locationId: "Location 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.

List Businesses inputs
Property Type Description
locationId Location ID string
If not specified, defaults to the authenticated location.
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
highlevel_oauth-list-businesses
Version
0.0.1
App
HighLevel
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
No