---
title: "find account by handle"
method: GET
path: "/find/account"
tags: ["Accounts"]
---

# find account by handle

`GET /find/account`

## Request

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

Returns the account matching the specified handle.

## Query parameters

- `handle` string, required
- `no_embed` boolean

## Headers

- `Prefer` 'no_sensitive_extras=true'

## Response `200`

successful

- 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
          - `href` string, uri
        - `database` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `operations` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `containers` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `ephemeral_containers` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `self` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
    - `permissions` Permission[]
      - `id` integer, required
      - `_type` string, required
      - `scope` string, required
      - `_links` PermissionLinks
        - `role` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `account` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `self` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
  - `_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

## Other responses

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

## Changes

- **2026-07-24** `1dc1e5b8c6eb`: 4 breaking, 2 info
  - the response property `_embedded/log_drains/items/drain_password` became optional for the status `200`
  - the response property `_embedded/log_drains/items/drain_username` became optional for the status `200`
  - the response property `_embedded/log_drains/items/logging_token` became optional for the status `200`
  - the response property `_embedded/log_drains/items/url` became optional for the status `200`
  - …2 more
- **2026-07-15** `5c71f4c63067`: 1 info
  - endpoint added

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