---
title: "List deployments for a project"
method: GET
path: "/projects/{project_id}/deployments"
tags: ["Deployments"]
---

# List deployments for a project

`GET /projects/{project_id}/deployments`

## Request

- Base URL: `https://sg.deployhq.com`
- URL: `https://sg.deployhq.com/projects/{project_id}/deployments`
- Auth: HTTP basic

Returns a paginated list of deployments for the project, excluding previews. Can be filtered by target server/group or limited to currently running deployments.

## Path parameters

- `project_id` string, required

## Query parameters

- `page` integer
- `per_page` integer
- `to` string
- `currently_running` string

## Response `200`

Success

- PaginationRecordsObject
  - `pagination` object
    - `current_page` integer
    - `total_pages` integer
    - `offset` integer
    - `total_records` integer
  - `records` object[]
    - `identifier` string
    - `servers` object[]
      - `id` integer
      - `identifier` string
      - `name` string
      - `protocol_type` string
      - `server_path` string
      - `last_revision` string
      - `preferred_branch` string
      - `branch` string
      - `notify_email` string
      - `server_group_identifier` string, nullable
      - `auto_deploy` boolean
      - `environment` string
      - `enabled` boolean
      - `agent` string, nullable
      - `atomic` boolean
      - `atomic_strategy` string
      - `atomic_retention` integer
      - `use_compression` boolean
      - `use_accelerated_transfer` boolean
      - `use_parallel_upload` boolean
      - `root_path` string
      - `position` integer
      - `created_at` string
      - `updated_at` string
      - `connection_checked_at` string, nullable
      - `connection_error_message` string, nullable
      - `hostname` string
      - `username` string
      - `port` string
      - `use_ssh_keys` boolean
      - `host_key` string
      - `unlink_before_upload` boolean
    - `project` object
      - `name` string
      - `permalink` string
      - `identifier` string
      - `public_key` string
      - `repository` object
        - `scm_type` string
        - `url` string
        - `port` integer, nullable
        - `username` string, nullable
        - `branch` string
        - `cached` boolean
        - `hosting_service` object
          - `name` string
          - `url` string
          - `tree_url` string
          - `commits_url` string
      - `repository_url` string
      - `zone` string
      - `last_deployed_at` string
      - `folder` string, nullable
      - `auto_deploy_url` string
    - `deployer` string, nullable
    - `deployer_avatar` string, nullable
    - `branch` string
    - `start_revision` object
      - `ref` string
    - `end_revision` object
      - `ref` string
    - `status` string
    - `timestamps` object
      - `queued_at` string
      - `started_at` string, nullable
      - `completed_at` string, nullable
      - `duration` string, nullable
      - `runs_at` string
    - `files` object
      - `0eac5db5-1bfa-46fd-a296-c617622de301` object
        - `changed` unknown[]
          - unknown
        - `removed` unknown[]
          - unknown
    - `configuration` object
      - `copy_config_files` boolean
      - `notification_addresses` string
      - `skip_project_files` boolean
    - `legacy` boolean
    - `deferred` boolean
    - `config_files_deployment` boolean
    - `overview` string, nullable
    - `metadata` object
    - `archived` boolean
    - `archived_at` string, nullable
    - `log_summary` string, nullable

## Other responses

- `401`: You are not authorized to access this resource. You need to authenticate yourself first.
- `403`: You are not allowed to access this resource. You do not have the necessary permissions.
- `404`: Not Found
- `500`: An unexpected error occurred on the server. The server was unable to process the request.

---

[API](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation.md) · [All operations](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/revisions/830264ae58be?raw)