---
title: "Get a project"
method: GET
path: "/projects/{project_id}"
tags: ["Projects"]
---

# Get a project

`GET /projects/{project_id}`

## Request

- Base URL: `https://app.honeybadger.io/v3`
- URL: `https://app.honeybadger.io/v3/projects/{project_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/honeybadger/apis/honeybadger-api/docs/projects/:project_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a single project.

## Path parameters

- `project_id` string, required

## Response `200`

Success

- object
  - `data` Project, required: A Honeybadger project: one application or service. Errors, Insights data, uptime sites, check-ins, deploys and integrations all belong to a project.
    - `id` string, required
    - `account_id` string, required: ID of the account this project belongs to
    - `name` string, required: Project name
    - `active` boolean, required: Whether the project is active
    - `disable_public_links` boolean, required: Whether public error links are disabled
    - `environments` string[], required: List of environment names seen in this project
    - `resolve_errors_on_deploy` boolean, required: Whether recording a deploy resolves every open fault
    - `user_url` string, nullable, required: Template linking a fault's affected user into your own system. `[user_id]` and `[user_email]` are substituted.
    - `source_url` string, nullable, required: Template linking a backtrace line to your source host. `[file]` and `[line]` are substituted.
    - `user_search_field` string, nullable, required: Context key identifying the affected user, when it is not in the default `context.user_email` or `context.user_id`.
    - `asana_workspace_id` string, nullable, required: Asana workspace used by the project's Asana integration
    - `customer_throttle` integer, nullable, required: Notices accepted per minute before throttling kicks in
    - `language` string, nullable, required: Primary programming language
    - `fault_count` integer, required: Total number of faults (errors) in this project
    - `unresolved_fault_count` integer, required: Number of unresolved faults
    - `last_notice_at` string, date-time, nullable, required: When the last error was received
    - `earliest_notice_at` string, date-time, nullable, required: The start of the retention window: now minus the project's `purge_days` (or the account's retention when unset), at most 180 days. Computed on each read, so it moves forward with the clock.
    - `purge_days` integer, nullable, required: Data retention period in days
    - `created_at` string, date-time, required: When the project was created
    - `links` WebLinks, required: Links into the Honeybadger web UI
      - `web` string, uri, required: The resource's page in the Honeybadger web UI, as an absolute URL. Resources without a page, such as outages and deploys, don't have `links`. For a project provisioned through Heroku, error, notice and comment links go through Heroku's single sign-on.
  - `meta` ResponseMeta
    - `request_id` string: Unique identifier for the request, for correlating with support

## Other responses

- `400`: A query parameter is malformed or outside its allowed values. `error.details` names the parameter.
- `401`: The credential is missing, invalid, expired or revoked (`unauthorized`), or was sent in a way v3 doesn't accept (see the examples).
- `403`: The credential isn't allowed to do this. `error.code` says why. An account or project the credential doesn't cover is 404 `not_found`, not 403.
- `404`: Resource not found
- `422`: No path names the account, so the API token has to. This is returned when the token covers more than one account and the account a request applies to cannot be determined. Use a token bound to a single account.

---

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