---
title: "Retrieve a project time summary"
method: GET
path: "/companies/{company}/projects/{project}/time-summary"
tags: ["Projects"]
---

# Retrieve a project time summary

`GET /companies/{company}/projects/{project}/time-summary`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/projects/{project}/time-summary`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Summarize the time logged on the tasks of a project, optionally between `from` and `to` (dates in the company time zone): total, billable, invoiced and pending-to-invoice seconds, broken down by member (with their names) and by task. Requires `projects:read` only, without `tasks:read` or `users:read`.

## Path parameters

- `company` string, uuid, required
- `project` string, uuid, required

## Query parameters

- `from` string, date
- `to` string, date

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` ProjectTimeSummary, required: Time logged on the tasks of a project, optionally limited to a date range.
    - `object` 'project_time_summary', required: Stripe-like discriminator. Always `project_time_summary` for this resource.
    - `project_id` string, uuid, required: UUID of the project.
    - `from` string, date, nullable, required: First day of the range, or `null` when not limited.
    - `to` string, date, nullable, required: Last day of the range, or `null` when not limited.
    - `total_seconds` integer, required: Logged seconds.
    - `billable_seconds` integer, required: Logged seconds marked billable.
    - `invoiced_seconds` integer, required: Billable seconds already invoiced.
    - `pending_seconds` integer, required: Billable seconds not yet invoiced.
    - `by_task` object[], required: Breakdown per task.
      - `task_id` string, uuid, required: UUID of the task.
      - `key` string, required: Task key.
      - `title` string, required: Task title.
      - `total_seconds` integer, required
      - `billable_seconds` integer, required
      - `invoiced_seconds` integer, required
      - `pending_seconds` integer, required
    - `by_user` object[], required: Breakdown per member.
      - `user_id` string, uuid, nullable, required: UUID of the member, or `null` when the user no longer exists.
      - `name` string, nullable, required: Member name.
      - `total_seconds` integer, required
      - `billable_seconds` integer, required

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)
