営業に問い合わせるログイン無料で始める
Developers
APIリファレンスConnect 事業アカウント

Connect 事業アカウント

外部会員の事業を運営会社と分けて管理する。作成だけで公開・決済・規約同意は行わない

エンドポイント
GET/v1/connect/accounts

このサービスの事業アカウントを一覧する

権限 connect:accounts:readnextCursor で続き

クエリ

  • memberExternalIdstring

    200文字まで

  • cursorstring

    100文字まで

  • limitinteger

    1〜100

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • memberExternalIdstring
  • namestring
  • statusenum
    activeinactive
  • versioninteger

    1以上

  • createdAtstring
  • updatedAtstring

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

GET/v1/connect/accounts
curl https://tooon.app/api/v1/connect/accounts \
  -H "Authorization: Bearer $TOOON_API_KEY"
レスポンス
{
  "data": [
    {
      "id": "clx8k2m0a0001",
      "externalId": "member-0001",
      "memberExternalId": "member-0001",
      "name": "山田 太郎",
      "status": "active",
      "version": 1,
      "createdAt": "2026-11-01T09:00:00.000Z",
      "updatedAt": "2026-11-01T09:00:00.000Z"
    }
  ],
  "nextCursor": null
}
GET/v1/connect/accounts/{id}

事業アカウントの状態を取得する

停止したアカウントの状態も確認できます。activeはこのアカウントの有効状態で、決済や契約の本人確認が完了したことを意味しません。内部の所有先IDや運営会社の事業者情報は返しません。

権限 connect:accounts:read

パスの値

  • idstring必須

    100文字まで

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • memberExternalIdstring
  • namestring
  • statusenum
    activeinactive
  • versioninteger

    1以上

  • createdAtstring
  • updatedAtstring

起こりうるエラー共通のエラー

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

GET/v1/…/accounts/{id}
curl https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001 \
  -H "Authorization: Bearer $TOOON_API_KEY"
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "externalId": "member-0001",
    "memberExternalId": "member-0001",
    "name": "山田 太郎",
    "status": "active",
    "version": 1,
    "createdAt": "2026-11-01T09:00:00.000Z",
    "updatedAt": "2026-11-01T09:00:00.000Z"
  }
}
PATCH/v1/connect/accounts/{id}

事業アカウントの表示名を変更する

expectedVersionには取得したversionを指定します。古い版は409 version_conflictです。所有者・サービス・externalId・契約や請求の法的名義は変更しません。

権限 connect:accounts:writeIdempotency-Key

パスの値

  • idstring必須

    100文字まで

送る項目JSON · 2項目

  • expectedVersioninteger必須

    1以上

  • namestring必須

    事業アカウントの表示名。契約・請求の法的名義の設定ではありません

    160文字まで

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • memberExternalIdstring
  • namestring
  • statusenum
    activeinactive
  • versioninteger

    1以上

  • createdAtstring
  • updatedAtstring

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

  • 409version_conflict

    古い版

PATCH/v1/…/accounts/{id}
curl -X PATCH https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001 \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedVersion": 1,
  "name": "山田 太郎"
}'
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "externalId": "member-0001",
    "memberExternalId": "member-0001",
    "name": "山田 太郎",
    "status": "active",
    "version": 1,
    "createdAt": "2026-11-01T09:00:00.000Z",
    "updatedAt": "2026-11-01T09:00:00.000Z"
  }
}
POST/v1/connect/members/{externalId}/accounts

外部会員の事業アカウントを作る

運営会社と分離された所有先を作ります。Tooonの社員・ログインユーザー・公開プロフィールは作りません。規約同意、契約締結、決済接続、名刺の作成や公開は行いません。本文のexternalIdはサービス内で一意です。同じ会員・externalId・nameの再送は同じアカウントを返し、他の内容は409 external_ref_conflictです。停止済みアカウントは再送で復活しません。

権限 connect:accounts:writeIdempotency-Key

パスの値

  • externalIdstring必須

    200文字まで

送る項目JSON · 2項目

  • externalIdstring必須

    200文字まで

  • namestring必須

    事業アカウントの表示名。契約・請求の法的名義の設定ではありません

    160文字まで

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • memberExternalIdstring
  • namestring
  • statusenum
    activeinactive
  • versioninteger

    1以上

  • createdAtstring
  • updatedAtstring

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

  • 409external_ref_conflict

    他の内容

POST/v1/…/members/{externalId}/accounts
curl -X POST https://tooon.app/api/v1/connect/members/member-0001/accounts \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "externalId": "member-0001",
  "name": "山田 太郎"
}'
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "externalId": "member-0001",
    "memberExternalId": "member-0001",
    "name": "山田 太郎",
    "status": "active",
    "version": 1,
    "createdAt": "2026-11-01T09:00:00.000Z",
    "updatedAt": "2026-11-01T09:00:00.000Z"
  }
}
POST/v1/connect/accounts/{id}/disable

事業アカウントの利用を停止する

expectedVersionを確認して停止します。古い版は409 version_conflictです。停止の再送は同じ状態を返します。データは削除せず、このAPIから再開・所有者変更はできません。

権限 connect:accounts:writeIdempotency-Key

パスの値

  • idstring必須

    100文字まで

送る項目JSON · 1項目

  • expectedVersioninteger必須

    1以上

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • memberExternalIdstring
  • namestring
  • statusenum
    activeinactive
  • versioninteger

    1以上

  • createdAtstring
  • updatedAtstring

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

  • 409version_conflict

    古い版

POST/v1/…/accounts/{id}/disable
curl -X POST https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/disable \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedVersion": 1
}'
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "externalId": "member-0001",
    "memberExternalId": "member-0001",
    "name": "山田 太郎",
    "status": "active",
    "version": 1,
    "createdAt": "2026-11-01T09:00:00.000Z",
    "updatedAt": "2026-11-01T09:00:00.000Z"
  }
}