---
title: "list accounts"
method: GET
path: "/accounts"
tags: ["Accounts"]
---

# list accounts

`GET /accounts`

## Request

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

Returns a paginated list of all accounts.

## Query parameters

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

## Headers

- `Prefer` 'no_sensitive_extras=true'

## Response `200`

successful

- ListAccountsForStack200Response
  - `_embedded` ListAccountsForStack200ResponseEmbedded, required
    - `accounts` Account[]
      - `id` integer, required
      - `type` string, required
      - `_type` string, required
      - `name` string, required
      - `handle` string, required
      - `onboarding_status` string, required
      - `number` string, required
      - `activated` boolean, required
      - `syslog_host` string, required
      - `syslog_port` integer, required
      - `bastion_host` string, required
      - `bastion_port` integer, required
      - `ssh_portal_port` integer, required
      - `container_count` integer, required
      - `domain_count` integer, required
      - `total_disk_size` integer, required
      - `total_app_count` integer, required
      - `app_container_count` integer, required
      - `database_container_count` integer, required
      - `total_database_count` integer, required
      - `created_at` string, dateTime, required
      - `updated_at` string, dateTime, required
      - `sweetness_stack` string, required
      - `gentlemanjerry_endpoint` string, required
      - `gentlemanjerry_certificate` string, required
      - `gentlemanjerry_docker_name` string, required
      - `gentlemanjerry_instance_id` string, required
      - `sweetness_stack_version` 'v1' | 'v2', required
      - `ca_body` string, required
      - `ca_private_key` string
      - `_embedded` AccountEmbedded, required
        - `log_drains` LogDrain[]
          - `id` integer, required
          - `_type` string, required
          - `handle` string, required
          - `drain_type` string, required
          - `drain_host` string, required
          - `drain_port` integer, required
          - `created_at` string, dateTime, required
          - `updated_at` string, dateTime, required
          - `status` string, required
          - `drain_username` string
          - `drain_password` string
          - `drain_apps` boolean, required
          - `drain_databases` boolean, required
          - `drain_ephemeral_sessions` boolean, required
          - `drain_proxies` boolean, required
          - `gentlemanjerry_certificate` string, required
          - `gentlemanjerry_docker_name` string, required
          - `gentlemanjerry_instance_id` string, required
          - `gentlemanjerry_host` string, required
          - `gentlemanjerry_port_mapping` array[], required
            - integer[]
          - `gentlemanjerry_allocation` string[], required
          - `url` string
          - `logging_token` string
          - `_links` LogDrainLinks
            - `account` ListAccountsForStack200ResponseLinksStack
              - …
            - `database` ListAccountsForStack200ResponseLinksStack
              - …
            - `operations` ListAccountsForStack200ResponseLinksStack
              - …
            - `containers` ListAccountsForStack200ResponseLinksStack
              - …
            - `ephemeral_containers` ListAccountsForStack200ResponseLinksStack
              - …
            - `self` ListAccountsForStack200ResponseLinksStack
              - …
        - `permissions` Permission[]
          - `id` integer, required
          - `_type` string, required
          - `scope` string, required
          - `_links` PermissionLinks
            - `role` ListAccountsForStack200ResponseLinksStack
              - …
            - `account` ListAccountsForStack200ResponseLinksStack
              - …
            - `self` ListAccountsForStack200ResponseLinksStack
              - …
      - `_links` AccountLinks
        - `organization` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `stack` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `apps` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `backups` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `databases` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `disks` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `services` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `operations` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `permissions` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `log_drains` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `metric_drains` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `certificates` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `vhosts` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `activity_reports` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `disk_attachments` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `self` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
  - `total_count` integer, required
  - `per_page` integer, required
  - `current_page` integer, required
  - `_links` ListAccountsForStack200ResponseLinks, required
    - `stack` 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`: 4 breaking, 3 info
  - the response property `_embedded/accounts/items/_embedded/log_drains/items/drain_password` became optional for the status `200`
  - the response property `_embedded/accounts/items/_embedded/log_drains/items/drain_username` became optional for the status `200`
  - the response property `_embedded/accounts/items/_embedded/log_drains/items/logging_token` became optional for the status `200`
  - the response property `_embedded/accounts/items/_embedded/log_drains/items/url` became optional for the status `200`
  - …3 more

[Operation history](https://skmtc.dev/aptible/apis/aptible-api-v1/changes/accounts/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)