---
title: "List deploys"
method: GET
path: "/projects/{project_id}/deploys"
tags: ["Deploys"]
---

# List deploys

`GET /projects/{project_id}/deploys`

## Request

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

Returns a list of deploys for the project.

## Path parameters

- `project_id` string, required

## Query parameters

- `limit` integer
- `before` string
- `after` string
- `environment` string
- `local_username` string

## Response `200`

Success

- object
  - `data` Deploy[], required
    - `id` string, required
    - `project_id` string, required: ID of the project this deploy belongs to
    - `environment` string, nullable, required: Deploy environment; null when the deploy named none
    - `revision` string, nullable, required: Source control revision
    - `repository` string, nullable, required: Source control repository
    - `local_username` string, nullable, required: Username of the person who triggered the deploy
    - `created_at` string, date-time, required: When the deploy was recorded
  - `pagination` TimeSeriesPagination: Pagination for a time-ordered collection
    - `limit` integer, required: Maximum items per page
    - `has_older` boolean, required: Whether older items exist. When true, follow `links.older`.
    - `has_newer` boolean, required: Whether newer items exist. When true, follow `links.newer`.
    - `oldest_cursor` string, nullable: Cursor for the oldest item on this page. Pass it back unchanged as `before`. Absent or null on collections that page on a timestamp rather than a cursor; use `links.older` instead.
    - `newest_cursor` string, nullable: Cursor for the newest item on this page. Pass it back unchanged as `after`. Absent or null on collections that page on a timestamp rather than a cursor, and on one-directional collections; use `links.newer` instead.
  - `links` TimeSeriesLinks: Navigation links for a time-ordered collection. Each link is a root-relative path (`/v3/...`); resolve it against the API host.
    - `self` string, uri-reference, required: This page
    - `older` string, nullable: Page of older items, or null when none exist
    - `newer` string, nullable: Page of newer items, or null when none exist. Always null on one-directional collections, which are documented as such.
  - `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)