帳號與工作空間

取得使用者資料

讀取已登入使用者本人的個人資料（顯示名稱、時區、頭像、佈景主題）；尚未建立時 profile 為 null。

POST /identity-api/user/profile/get

契約檢閱日期： 2026-10-21 · sha256:563d2d581da0ad29

閱讀 Markdown 下載公開契約下載 OpenAPI

概覽

讀取已登入使用者本人的個人資料（顯示名稱、時區、頭像、佈景主題）；尚未建立時 profile 為 null。

成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。

驗證與權限

接受的憑證類別: user_session, delegated_oauth, personal_access_token
委派能力: agent:operate
最低工作空間角色: 此契約沒有最低工作空間角色要求；擁有權與授權檢查仍然適用。
存取範圍: 此使用者有權存取的資源
需要所有工作空間同意: 否
變更狀態: 否
操作完成時: synchronous_http_response

權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。

請求欄位

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

請求欄位
欄位 / 分支	類型 / 必填	約束
`$`	`object`在父物件中必填	`additionalProperties: false`
`include_version`	`boolean`選填／項目	選填。true 會將資源版本加入回應。 —

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

回應與完成

成功 HTTP 狀態：200。操作完成時： synchronous_http_response.

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

回應與完成
欄位 / 分支	類型 / 必填	約束
`$`	`object`在父物件中必填	—
`action`	`string`在父物件中必填	`const: "get"`
`profile`	`object \| null`在父物件中必填	—
`profile`anyOf 1	`object`在父物件中必填	—
`profile.user_id`anyOf 1	`string`在父物件中必填	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`profile.display_name`anyOf 1	`string \| null`在父物件中必填	—
`profile.display_name`anyOf 1 / anyOf 1	`string`在父物件中必填	—
`profile.display_name`anyOf 1 / anyOf 2	`null`在父物件中必填	—
`profile.timezone`anyOf 1	`string \| null`在父物件中必填	—
`profile.timezone`anyOf 1 / anyOf 1	`string`在父物件中必填	—
`profile.timezone`anyOf 1 / anyOf 2	`null`在父物件中必填	—
`profile.avatar_url`anyOf 1	`string \| null`在父物件中必填	—
`profile.avatar_url`anyOf 1 / anyOf 1	`string`在父物件中必填	—
`profile.avatar_url`anyOf 1 / anyOf 2	`null`在父物件中必填	—
`profile.avatar_preview_url`anyOf 1	`string \| null`選填／項目	—
`profile.avatar_preview_url`anyOf 1 / anyOf 1	`string`選填／項目	`format: "uri"`
`profile.avatar_preview_url`anyOf 1 / anyOf 2	`null`選填／項目	—
`profile.avatar_preview_expires_at`anyOf 1	`string \| null`選填／項目	—
`profile.avatar_preview_expires_at`anyOf 1 / anyOf 1	`string`選填／項目	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"`
`profile.avatar_preview_expires_at`anyOf 1 / anyOf 2	`null`選填／項目	—
`profile.theme`anyOf 1	`string \| null`在父物件中必填	—
`profile.theme`anyOf 1 / anyOf 1	`string`在父物件中必填	`enum: ["light","dark","system"]`
`profile.theme`anyOf 1 / anyOf 2	`null`在父物件中必填	—
`profile.created_at`anyOf 1	`string \| null`在父物件中必填	—
`profile.created_at`anyOf 1 / anyOf 1	`string`在父物件中必填	—
`profile.created_at`anyOf 1 / anyOf 2	`null`在父物件中必填	—
`profile.updated_at`anyOf 1	`string \| null`在父物件中必填	—
`profile.updated_at`anyOf 1 / anyOf 1	`string`在父物件中必填	—
`profile.updated_at`anyOf 1 / anyOf 2	`null`在父物件中必填	—
`profile.deletion_scheduled_at`anyOf 1	`string \| null`在父物件中必填	—
`profile.deletion_scheduled_at`anyOf 1 / anyOf 1	`string`在父物件中必填	—
`profile.deletion_scheduled_at`anyOf 1 / anyOf 2	`null`在父物件中必填	—
`profile.hard_delete_at`anyOf 1	`string \| null`在父物件中必填	—
`profile.hard_delete_at`anyOf 1 / anyOf 1	`string`在父物件中必填	—
`profile.hard_delete_at`anyOf 1 / anyOf 2	`null`在父物件中必填	—
`profile.version`anyOf 1	`integer`選填／項目	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`profile`anyOf 2	`null`在父物件中必填	—

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "const": "get"
    },
    "profile": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "user_id": {
              "type": "string",
              "format": "uuid",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
            },
            "display_name": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "timezone": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "avatar_url": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "avatar_preview_url": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uri"
                },
                {
                  "type": "null"
                }
              ]
            },
            "avatar_preview_expires_at": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "theme": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "light",
                    "dark",
                    "system"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "created_at": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "updated_at": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "deletion_scheduled_at": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "hard_delete_at": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "version": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "user_id",
            "display_name",
            "timezone",
            "avatar_url",
            "theme",
            "created_at",
            "updated_at",
            "deletion_scheduled_at",
            "hard_delete_at"
          ]
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "action",
    "profile"
  ]
}

錯誤與安全重試

檢查 HTTP 狀態和回應內容。400 驗證錯誤可能包含 ZodError；處理常式錯誤使用 error、message 和 code 欄位。保留 request_id 或 x-request-id 以便診斷，但不要保留憑證。先解決 401/403 存取錯誤再重試，並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx，先讀取現有結果。僅在支援時重複使用冪等鍵；重試行為因操作而異，並不保證恰好傳送一次。

故障排查指南

範例

這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。

在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證，且不要放入瀏覽器程式碼。代理程式請使用 sosoapi auth login 透過瀏覽器登入，並由 CLI 更新憑證。

request.json

{}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/profile/get" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/profile/get", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /identity-api/user/profile/get < request.json

合成回應範例

{
  "action": "get",
  "profile": null
}

MCP： sosoapi_get_user_profile

全部 API 操作驗證與權限