# GET /v1/users

Annictに登録されているユーザ情報を取得することができます。

## フィールド

| 名前                     | 概要                   |
| ---------------------- | -------------------- |
| id                     | ユーザID                |
| username               | URLなどで使用されているユーザ名    |
| name                   | ユーザの名前               |
| description            | プロフィール               |
| url                    | ユーザのURL              |
| avatar\_url            | アバター画像               |
| background\_image\_url | 背景画像                 |
| records\_count         | 記録数                  |
| followings\_count      | ユーザがフォローしている人の数      |
| followers\_count       | ユーザをフォローしている人の数      |
| wanna\_watch\_count    | ステータスを「見たい」にしている作品の数 |
| watching\_count        | ステータスを「見てる」にしている作品の数 |
| watched\_count         | ステータスを「見た」にしている作品の数  |
| on\_hold\_count        | ステータスを「中断」にしている作品の数  |
| stop\_watching\_count  | ステータスを「中止」にしている作品の数  |
| created\_at            | ユーザ登録した日時            |

## パラメータ

| 名前                | 概要                                                | 使用例                                   |
| ----------------- | ------------------------------------------------- | ------------------------------------- |
| fields            | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,username                    |
| filter\_ids       | ユーザをIDで絞り込みます。                                    | filter\_ids=1,2,3                     |
| filter\_usernames | ユーザをユーザ名で絞り込みます。                                  | filter\_usernames=shimbaco,datekoichi |
| page              | ページ数を指定します。                                       | page=2                                |
| per\_page         | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30                          |
| sort\_id          | ユーザをIDで並び替えます。`asc` または `desc` が指定できます。           | sort\_id=desc                         |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/users?access_token=(access_token)&filter_usernames=shimbaco
```

```javascript
{
  "users": [
    {
      "id": 2,
      "username": "shimbaco",
      "name": "Koji Shimba",
      "description": "アニメ好きが高じてこのサービスを作りました。聖地巡礼を年に数回しています。",
      "url": "http://shimba.co",
      "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
      "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
      "records_count": 2369,
      "followings_count": 258,
      "followers_count": 205,
      "wanna_watch_count": 237,
      "watching_count": 103,
      "watched_count": 335,
      "on_hold_count": 45,
      "stop_watching_count": 244,
      "created_at": "2014-03-02T15:38:40.000Z"
    }
  ],
  "total_count": 1,
  "next_page": null,
  "prev_page": null
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.annict.com/docs/ja/api/v1/users.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.