View as Markdown
Harvest icon

Harvest ACTION

List User Assignments

List user assignments, automatically following pagination up to 200. Omit Project ID to use the global endpoint; provide a Project ID to list assignments for a single project. Example: call with projectId set to the Isla Sorna Genetics Lab project's ID to see who is staffed on it. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Harvest account once, then configure and run List User Assignments 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: "harvest-list-user-assignments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    harvest: { authProvisionId: "apn_xxxxxxx" },
    accountId: "Account ID",
    projectId: "Project 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 User Assignments inputs
Property Type Description
accountId Account ID string
Your Harvest account ID, e.g. 1234567. Run List Account ID Options to find it.
Required
projectId Project ID string
Optional free-form project ID, e.g. 14308069. When set, routes to /projects/{project_id}/user_assignments; when omitted uses global /user_assignments. Run Get Projects first to find valid IDs.
Optional
userId User ID string
Free-form user ID filter, applies whether using the global /user_assignments endpoint or a project-scoped /projects/{project_id}/user_assignments endpoint, e.g. 1782959. Run List Users first to find valid IDs.
Optional
isActive Is Active boolean
Only return active or inactive user assignments.
Optional
updatedSince Updated Since string
Only return records updated since this UTC datetime, e.g. 2019-06-25T15:30:00Z.
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
harvest-list-user-assignments
Version
0.0.1
App
Harvest
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes