---
title: "Gets information for the account."
method: GET
path: "/accounts/{name}"
tags: ["Account Operations"]
---

# Gets information for the account.

`GET /accounts/{name}`

## Request

- Base URL: `https://replace-with-account.api.decodable.co/v1alpha2`
- URL: `https://replace-with-account.api.decodable.co/v1alpha2/accounts/{name}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://auth.decodable.co/authorize?audience=https://api.decodable.co/`
    - Token URL: `https://auth.decodable.co/oauth/token`
- TypeScript: <https://skmtc.dev/decodable/apis/decodable-control-plane/docs/accounts/:name/get.ts> (a function with typed inputs; its response is checked against the schema)

Requires permission matching: `account:read:<name>`, where `name` is the account name.

## Response `200`

Account information

- AccountInfo: Account information
  - `subscription` Subscription, required: Subscription information
    - `plan_id` string: plan id
    - `capabilities` string[]: Describes which additional capabilities are enabled for this account. Possible values are "custom_pipelines". New values may be added in future API versions; consumers should be able to gracefully handle unknown values.
  - `deployment_type` 'managed' | 'byoc', required: The deployment type.
  - `data_plane_hostname` string, required: The hostname of the data plane API.
  - `data_plane` object, required: data plane information
    - `data_plane_id` string, string: The ID of the data plane.
    - `hostname` string: The hostname of the data plane API.
    - `last_registration_time` string, date-time: The last registration time of the data plane
    - `last_heart_beat_time` string, date-time: The last heart beat time of the data plane
    - `mtls_signing_state` 'NONE' | 'REQUESTED' | 'AVAILABLE': The state of the mTLS certificate for authenticating the data plane

## Other responses

- `401`: Access denied: Missing or invalid credentials
- `403`: Access denied: requesting user lacks a required permission.
- `default`: An error has occurred.

---

[API](https://skmtc.dev/decodable/apis/decodable-control-plane.md) - [All operations](https://skmtc.dev/decodable/apis/decodable-control-plane/llms.txt) - [OpenAPI document](https://skmtc.dev/decodable/apis/decodable-control-plane/revisions/9718a3019da8?raw)