APIリファレンスAPIキー

APIキー

キーが有効か、どの権限を持つかを確かめる

エンドポイント

GET/v1/me

GET/v1/me

APIキーの確認

このAPIキーが有効か、どのワークスペースのキーで、どの権限（scope）を持つかを返します。接続確認に使えます。

有効なキーなら呼べます

返る項目data の中身 · 200

apiKeyobject
中の項目 3
- idstring
- namestring
- scopesenum[]
workspaceobject
中の項目 2
- idstring
- namestring

GET/v1/me

curl https://tooon.app/api/v1/me \
  -H "Authorization: Bearer $TOOON_API_KEY"

200OK

{
  "data": {
    "apiKey": {
      "id": "clx8k2m0a0001",
      "name": "山田 太郎",
      "scopes": [
        "connect:members:read"
      ]
    },
    "workspace": {
      "id": "clx8k2m0a0001",
      "name": "山田 太郎"
    }
  }
}