ユーザーのフォローとフォロー解除API

プラン: Free、Premium、Ultimate
提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、ユーザーアカウントのフォロワーアクションを実行します。詳細については、ユーザーをフォローを参照してください。

ユーザーをフォローする

指定されたユーザーアカウントをフォローします。

POST /users/:id/follow

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数	はい	ユーザーアカウントのID

リクエスト例:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/users/3/follow"

レスポンス例:

{
  "id": 1,
  "username": "john_smith",
  "name": "John Smith",
  "state": "active",
  "locked": false,
  "avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
  "web_url": "http://localhost:3000/john_smith"
}

ユーザーのフォローを解除する

指定されたユーザーアカウントのフォローを解除します。

POST /users/:id/unfollow

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数	はい	ユーザーアカウントのID

リクエスト例:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/users/3/unfollow"

ユーザーをフォローしているすべてのアカウントを一覧表示する

指定されたユーザーをフォローしているすべてのユーザーアカウントを一覧表示します。

GET /users/:id/followers

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数	はい	ユーザーアカウントのID

リクエスト例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/users/3/followers"

レスポンス例:

[
  {
    "id": 2,
    "name": "Lennie Donnelly",
    "username": "evette.kilback",
    "state": "active",
    "locked": false,
    "avatar_url": "https://www.gravatar.com/avatar/7955171a55ac4997ed81e5976287890a?s=80&d=identicon",
    "web_url": "http://127.0.0.1:3000/evette.kilback"
  },
  {
    "id": 4,
    "name": "Serena Bradtke",
    "username": "cammy",
    "state": "active",
    "locked": false,
    "avatar_url": "https://www.gravatar.com/avatar/a2daad869a7b60d3090b7b9bef4baf57?s=80&d=identicon",
    "web_url": "http://127.0.0.1:3000/cammy"
  }
]

ユーザーがフォローしているすべてのアカウントを一覧表示する

指定されたユーザーがフォローしているすべてのユーザーアカウントを一覧表示します。

GET /users/:id/following

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数	はい	ユーザーアカウントのID

リクエスト例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/users/3/following"