Sign in
Account

Read an account

Reads a specific account.

get/account/{id}

Path parameters

idinteger required

The ID of the account.

Query parameters

metadata_includestring

Comma-separated list of metadata properties to include in the response. Available values [schemas, tags].

show_deletedboolean

When true, returns the account even if it has been soft-deleted. Soft-deleted accounts are identified by a non-null deleted_at timestamp in the response. Defaults to false, in which case soft-deleted accounts respond with 404 Not Found.

Response

An object representing the account.

idinteger required

A system-wide unique ID for the account.

namestring required

The account name.

slugstring required

An organization-wide unique slug for the account.

organization_idinteger required

The ID of the organization that owns this account.

status'active' | 'inactive' | 'deleted' required

The status of the account. The deleted value is only returned in responses to GET /account/{id}?show_deleted=true for accounts that have been soft-deleted; it cannot be set via create or update.

deleted_atstring date-time nullable

The timestamp at which the account was soft-deleted, or null if the account is still active. Only populated in responses to GET /account/{id}?show_deleted=true.

Example response

{
  "id": 1234,
  "name": "Crypto Kong",
  "slug": "crypto-kong",
  "organization_id": 123,
  "status": "active",
  "deleted_at": "2026-05-15T12:34:56.000Z",
  "metadata": {
    "key": "value"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.