get_api_settings_chat_accounts

GET

/api/settings/chat-accounts

curl --request GET \
  --url https://example.com/api/settings/chat-accounts

Responses

200

Media typeapplication/json

Array<object>

One linked chat account in the settings view: platform, the external id (for display) and whether the post-completion task TL;DR digest is sent to it.

object

external_id

required

string

forum_chat_id

#716 §27 — the Telegram supergroup id (or @username) where per-task forum topics are created. None ⇒ unset (Telegram-only).

string | null

forum_topics_enabled

required

ADR 0049 F2 — per-task forum topics enabled for this account (Telegram-only; always false on other platforms).

boolean

notify_task_tldr

required

boolean

platform

required

string

Example^generated

[
  {
    "external_id": "example",
    "forum_chat_id": "example",
    "forum_topics_enabled": true,
    "notify_task_tldr": true,
    "platform": "example"
  }
]

401

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object

code

required

Machine-readable, stable error code.

string

Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error

details

One of:

null

null

object

Present only on a quota-exceeded 403 — the inline upgrade-CTA payload.

object

key

required

The entitlement feature key that was hit, e.g. apps.max_count.

string

limit

required

The plan’s limit for this key.

integer format: int64

upgrade_url

required

Where to send the user to upgrade.

string

used

required

Current usage (count or bytes, per the key).

integer format: int64

error

required

Human-readable message (the server’s English text; the client may localize by code).

string

Example

{
  "code": "not_found"
}

500

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object

code

required

Machine-readable, stable error code.

string

Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error

details

One of:

null

null

object

Present only on a quota-exceeded 403 — the inline upgrade-CTA payload.

object

key

required

The entitlement feature key that was hit, e.g. apps.max_count.

string

limit

required

The plan’s limit for this key.

integer format: int64

upgrade_url

required

Where to send the user to upgrade.

string

used

required

Current usage (count or bytes, per the key).

integer format: int64

error

required

Human-readable message (the server’s English text; the client may localize by code).

string

Example

{
  "code": "not_found"
}