View as Markdown
Hex icon

Hex ACTION

List Projects

List all viewable projects. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Hex account once, then configure and run List Projects 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: "hex-list-projects",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hex: { authProvisionId: "apn_xxxxxxx" },
    includeArchived: true,
    includeComponents: 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 Projects inputs
Property Type Description
includeArchived Include Archived boolean
Whether to include archived projects in the results.
Optional
includeComponents Include Components boolean
Whether to include components in the results.
Optional
includeTrashed Include Trashed boolean
Whether to include trashed projects in the results.
Optional
includeSharing Include Sharing boolean
Whether to include sharing information in the results.
Optional
statuses Statuses string[]
The statuses to filter the projects by.
Optional
categories Categories string[]
The categories to filter the projects by.
Optional
creatorEmail Creator Email string
The email of the creator of the projects.
Optional
ownerEmail Owner Email string
The email of the owner of the projects.
Optional
collectionId Collection ID string
The ID of the collection of the projects.
Optional
sortBy Sort By string
The field to sort the projects by.
Optional
sortDirection Sort Direction string
The direction to sort the projects by.
Optional
maxResults Max Results integer
The maximum number of results to return.
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
hex-list-projects
Version
0.0.1
App
Hex
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes