View as Markdown
HubSpot icon

HubSpot ACTION

List Custom Object Properties

List all property definitions for a specific custom object type. Returns each property's name, label, type, fieldType, and enum options (for enumeration fields). Use List Custom Object Schemas first to obtain the correct objectType identifier (either fullyQualifiedName like p_pd_eval_movie or objectTypeId like 2-12345678). Standard object types (contacts, companies, deals, tickets) are not supported here — use Get Properties or Search Properties for those. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HubSpot account once, then configure and run List Custom Object Properties 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: "hubspot-list-custom-object-properties",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hubspot: { authProvisionId: "apn_xxxxxxx" },
    objectType: "Object Type",
    archived: true,
  },
})

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 Custom Object Properties inputs
Property Type Description
objectType Object Type string
The custom object type identifier — either the fullyQualifiedName (e.g. p_pd_eval_movie) or the objectTypeId (e.g. 2-12345678). Use List Custom Object Schemas to discover available custom object types.
Required Dynamic
archived Include Archived boolean
Set to true to include archived (soft-deleted) properties. Default: false.
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
hubspot-list-custom-object-properties
Version
0.0.4
App
HubSpot
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes