# Get Time Report — Harvest

> Retrieve total hours logged, aggregated by a chosen dimension (clients, projects, tasks, or team) over a date range, automatically following pagination up to 200 results. Use when the user asks "how many hours were logged/worked on X"…

- Key: `harvest-get-time-report`
- Type: Action (Read-only)
- Version: 0.0.1
- App: Harvest (`harvest`) — https://pipedream.com/apps/harvest.md
- This page (HTML): https://pipedream.com/apps/harvest/actions/get-time-report
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/harvest/actions/get-time-report/get-time-report.mjs

## Description

Retrieve total hours logged, aggregated by a chosen dimension (clients, projects, tasks, or team) over a date range, automatically following pagination up to 200 results. Use when the user asks "how many hours were logged/worked on X", "how much time did the team spend on Y", or wants a time report/summary/breakdown — this is the only tool that returns aggregated totals; **List Time Entries** returns individual raw entries you would have to sum yourself. The Report By value selects which `/reports/time/{dimension}` endpoint is called. Example: call with reportBy="projects", from="20260901", to="20260930" to see total hours logged per project for the month. [See the documentation](https://help.getharvest.com/api-v2/reports-api/reports/time-reports/)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `accountId` | `string` | Yes | Your Harvest account ID, e.g. 1234567. Run List Account ID Options to find it. |
| `reportBy` | `string` | Yes | The dimension to group the report by. One of: clients, projects, tasks, team. |
| `from` | `string` | Yes | Start of the report range, format YYYYMMDD, e.g. 20260901. |
| `to` | `string` | Yes | End of the report range, format YYYYMMDD, e.g. 20260910. |
| `includeFixedFee` | `boolean` | No | Whether to include fixed-fee projects in the report. |
| `includeForecast` | `boolean` | No | Whether to include forecast data (only supported when Report By is projects or team). |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "harvest",
      },
    },
  },
)

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: "harvest-get-time-report",
  arguments: {
    accountId: "Account ID",
    reportBy: "Report By",
  },
})
```

**TypeScript**

```ts
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-get-time-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    harvest: { authProvisionId: "apn_xxxxxxx" },
    accountId: "Account ID",
    reportBy: "Report By",
  },
})

console.log(result)
```

**cURL**

```bash
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": "harvest-get-time-report",
    "configured_props": {
      "harvest": { "authProvisionId": "apn_xxxxxxx" },
      "accountId": "Account ID",
      "reportBy": "Report By"
    }
  }'
```

---

- App: https://pipedream.com/apps/harvest.md · All apps: https://pipedream.com/apps