HubSpot ACTION
List Custom Objects
List records of a custom object type with pagination and property selection. HubSpot does NOT support the /search endpoint for custom objects — use this list action to browse records, then use Get Custom Object to fetch full details by ID. Use List Custom Object Schemas first to obtain the correct
objectType identifier (fullyQualifiedName or objectTypeId). Use List Custom Object Properties to discover which properties are available to request. 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 Objects 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-objects",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
hubspot: { authProvisionId: "apn_xxxxxxx" },
objectType: "Object Type",
properties: ["Properties"],
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "hubspot-list-custom-objects",
"configured_props": {
"hubspot": { "authProvisionId": "apn_xxxxxxx" },
"objectType": "Object Type",
"properties": ["Properties"]
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "hubspot",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "hubspot-list-custom-objects",
arguments: {
objectType: "Object Type",
properties: ["Properties"],
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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 |
properties Properties | string[] | Property names to include in the returned records. If not specified, only the default display property is returned. Use List Custom Object Properties to discover available property names. e.g. ["title", "year", "director"]. Optional |
limit Limit | integer | Maximum number of records to return per page. Max: 100, default: 10. Optional |
after After (Pagination Cursor) | string | Paging cursor from a previous response for retrieving the next page of results. 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-objects
- Version
- 0.0.4
- App
- HubSpot
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗