---
title: "List project tool usages"
method: GET
path: "/v2/projects/{project_id}/tool_usages"
tags: ["tool_usages"]
---

# List project tool usages

`GET /v2/projects/{project_id}/tool_usages`

## Request

- Base URL: `https://api.hubstaff.com`
- URL: `https://api.hubstaff.com/v2/projects/{project_id}/tool_usages`
- Auth: OAuth 2
  - Authorization code: `https://account.hubstaff.com/authorizations/new`
  - Token URL: `https://account.hubstaff.com/access_tokens` scopes: `hubstaff:read`, `hubstaff:write`
- TypeScript: <https://skmtc.dev/hubstaff/apis/hubstaff-v2-api/docs/v2/projects/:project_id/tool_usages/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a collection of tool usages (productivity tool usage) for the given project.

Results can be filtered by time_slot[start]/[stop], user_ids[], task_ids[], project_ids[], and tool_type.

The preferred endpoints to fetch tool usage data are the daily endpoints.

Requires Owner or Organization Manager role (with view others data permission).

Note: Date range limit is 7 days. Earliest date is 1 month ago.

## Path parameters

- `project_id` integer, required

## Query parameters

- `page_start_id` integer
- `page_limit` integer
- `time_slot[start]` string, date-time, required
- `time_slot[stop]` string, date-time, required
- `user_ids` integer[]
- `task_ids` integer[]
- `tool_type` 'application' | 'url'
- `include` string[]

## Response `200`

A list of tool usages

- object
  - `tool_usages` ToolUsage[]
    - `id` integer, required: Tool usage ID
    - `name` string, required: URL site or application name
    - `tool_type` string, required: Tool type: application or url
    - `date` string, date, required: Organization date
    - `time_slot` string, date-time, required: Time slot
    - `user_id` integer, required: User ID
    - `project_id` integer, required: Project ID
    - `task_id` integer: Task ID
    - `tracked` integer, required: Total time in seconds spent on this tool
    - `details` UrlActivityDetail[]: URL activity details
      - `title` string, required: Page title
      - `url` string, required: Visited URL
      - `tracked` integer, required: Total time in seconds spent on this URL
    - `activations` integer: Number of times the app was brought to focus
    - `created_at` string, date-time, required: When the record was created
    - `updated_at` string, date-time, required: When the record was last updated

## Other responses

- `400`: Invalid parameters
- `401`: Unauthorized
- `403`: API access is only for organizations on an active plan
- `404`: Could not find record
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/hubstaff/apis/hubstaff-v2-api.md) - [All operations](https://skmtc.dev/hubstaff/apis/hubstaff-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hubstaff/apis/hubstaff-v2-api/revisions/c6b90e4e4bdc?raw)