Skip to content

Retrieves the current account for the token accessing the API

client.account.retrieve(?): Account { info, metadata, spec }

GET/v1/account

Retrieves the current account for the token accessing the API. Useful to check if the credentials are valid.

ReturnsExpand Collapse

Account { info, metadata, spec }

Account is an account resource.

info: Info { webhookEventsHmacSecret }

AccountInfo contains information about the account.

webhookEventsHmacSecret?: string

The generated secret that will sign all webhooks that are sent to your configured Webhook URL. Formatted as "wh_asdf1234" per the https://www.standardwebhooks.com/ format.

metadata: AccountResourceMetadata { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

name: string

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

externalId?: string

External ID for the resource (e.g., a workflow ID from an external system)

labels?: Record<string, string>

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: AccountSpec { billingEmail, description, domain, workspaces }

AccountSpec contains the specification for an account.

billingEmail?: string

description?: string

domain?: string

workspaces?: Array<Workspace { metadata, spec } >

metadata: AccountResourceMetadata { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

name: string

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

externalId?: string

External ID for the resource (e.g., a workflow ID from an external system)

labels?: Record<string, string>

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: WorkspaceSpec { description }

description?: string

Retrieves the current account for the token accessing the API

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const account = await client.account.retrieve();

console.log(account.info);

{
  "info": {
    "webhookEventsHmacSecret": "webhookEventsHmacSecret"
  },
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "name": "name",
    "profileId": "profileId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "billingEmail": "billingEmail",
    "description": "description",
    "domain": "domain",
    "workspaces": [
      {
        "metadata": {
          "id": "id",
          "accountId": "accountId",
          "name": "name",
          "profileId": "profileId",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        },
        "spec": {
          "description": "description"
        }
      }
    ]
  }
}

Returns Examples

{
  "info": {
    "webhookEventsHmacSecret": "webhookEventsHmacSecret"
  },
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "name": "name",
    "profileId": "profileId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "billingEmail": "billingEmail",
    "description": "description",
    "domain": "domain",
    "workspaces": [
      {
        "metadata": {
          "id": "id",
          "accountId": "accountId",
          "name": "name",
          "profileId": "profileId",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        },
        "spec": {
          "description": "description"
        }
      }
    ]
  }
}