Skip to content

Markdown ソース

生の markdown をそのまま参照でき、コピー、自動化、AI agent に使えます。

Markdown を表示

User API

自分の情報を取得する

prolog
GET API_BASE/users/me

認可要否

OAuthAPIKey
YesYes

レスポンス

json
{
  "data": UserObject,
  "ts": 1723923923
}

自分の情報を更新する

prolog
PUT API_BASE/users/me

認可要否

OAuthAPIKey
YesYes

リクエストボディ

json
{
  "name": "John Wick",
  "bio": "...",
  "avatar_image_url": "https://...",
  "social_ids": [
    {
      "name": "twitter",
      "value": "john_wick"
    }
  ]
}

レスポンス

json
{
  "data": UserObject,
  "ts": 1723923923
}

Email を更新する

prolog
PUT API_BASE/users/me/email

認可要否

OAuthAPIKey
YesYes

リクエストボディ

json
{
  "email": "new@example.com",
  "code": "123456"
}

レスポンス

json
{
  "data": UserObject,
  "ts": 1723923923
}

Options を更新する

prolog
PUT API_BASE/users/me/options

認可要否

OAuthAPIKey
YesYes

リクエストボディ

json
{
  "options": {
    "language": "en"
  }
}

レスポンス

json
{
  "data": UserObject,
  "ts": 1723923923
}

ユーザーを取得する

prolog
GET API_BASE/users/:user_id

パラメータ

ParameterTypeDescription
user_idintuser の ID

レスポンス

json
{
  "data": UserObject,
  "ts": 1723923923
}

ユーザーを検索する

prolog
GET API_BASE/users/query

認可要否

OAuthAPIKey
YesYes

クエリパラメータ

ParameterTypeDescription
emailstringuser の email

レスポンス

json
{
  "data": [UserObject],
  "ts": 1723923923
}