---
title: "list deployments"
method: GET
path: "/deployments"
tags: ["Deployments"]
---

# list deployments

`GET /deployments`

## Request

- Base URL: `https://api.aptible.com`
- URL: `https://api.aptible.com/deployments`
- Auth: API key in header `Authorization`

Returns a paginated list of all deployments.

## Query parameters

- `page` integer
- `per_page` integer
- `no_embed` boolean

## Headers

- `Prefer` 'no_sensitive_extras=true'

## Response `200`

successful

- ListDeployments200Response
  - `_embedded` ListDeployments200ResponseEmbedded, required
    - `deployments` Deployment[]
      - `id` integer, required
      - `_type` string, required
      - `status` string, required
      - `operation_id` integer, required
      - `app_id` integer, required
      - `configuration_id` integer, required
      - `image_id` integer, required
      - `source_id` integer, required
      - `setting_id` integer, required
      - `docker_image` string, required
      - `docker_repository_url` string, required
      - `git_repository_url` string, required
      - `git_ref` string, required
      - `git_commit_sha` string, required
      - `git_commit_timestamp` string, dateTime, required
      - `git_commit_url` string, required
      - `git_commit_message` string, required
      - `created_at` string, dateTime, required
      - `updated_at` string, dateTime, required
      - `deleted_at` string, dateTime, required
      - `_links` DeploymentLinks
        - `app` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `configuration` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `image` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `source` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `setting` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `self` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
  - `total_count` integer, required
  - `per_page` integer, required
  - `current_page` integer, required
  - `_links` ListDeployments200ResponseLinks, required
    - `parent` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `next` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `prev` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `self` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri

## Other responses

- `default`: Error response. Often a 4xx or 5xx status code

## Changes

- **2026-07-24** `1dc1e5b8c6eb`: 3 info
  - added the new optional `header` request parameter `Prefer`
  - added the new optional `query` request parameter `no_embed`
  - added the new optional `query` request parameter `per_page`
- **2026-01-22** `c53f9485170a`: 2 info
  - added the optional property `_embedded/deployments/items/_links/setting` to the response with the `200` status
  - added the required property `_embedded/deployments/items/setting_id` to the response with the `200` status

[Operation history](https://skmtc.dev/aptible/apis/aptible-api-v1/changes/deployments/get.md)

---

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