---
title: "プレイヤーリストの照会"
slug: "gamepot-getplayerlist"
updated: 2026-09-17T09:57:56Z
published: 2026-09-17T09:57:56Z
canonical: "api.ncloud-docs.com/gamepot-getplayerlist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# プレイヤーリストの照会

Classic/VPC環境で利用できます。

ゲームプレイヤーリストを照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /v2/players |

### リクエストヘッダ

GAMEPOT 3.0 APIで共通して使用されるヘッダの詳細は、[GAMEPOT 3.0のリクエストヘッダ](/docs/ja/gamepot-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `filter` | String | Required | 絞り込みの条件 - レスポンスボディの一部のフィールドで絞り込み - 完全一致する値のみ絞り込み - 条件がない場合、空の値`{}`を入力 - <例> `{"player_id":"{プレイヤー ID}"}`、`{"name":"{プレイヤー名}"}`、`{"deleted":false}` |
| `sort` | String | Optional | ソートの基準 - `{基準:方式}`形式で入力 - 基準: レスポンスボディの Stringタイプフィールド - 方式: `-1` \| `1` - `-1`: 降順 - `1`: 昇順 - <例> `{"createdAt":"-1"}`: 作成日時基準の降順 |
| `option` | String | Optional | 追加オプション: [option](/docs/ja/gamepot-getplayerlist#option) - <例> `{"offset":0,"per_page":20}`: 最初の項目から20個表示 |

#### `option`

`option`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `offset` | Integer | Optional | 照会開始オフセット - 0~N |
| `per_page` | Integer | Optional | ページごとの項目数 - 1~100 |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://dashboard-api.gamepot.ntruss.com/v2/players?filter=%7B%22project_id%22%3A%2285ecd393-****-****-****-d85c321772da%22%7D&sort=%7B%22createdAt%22%3A%22-1%22%7D&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `totalCount` | Integer | - | レスポンス総数 |
| `players` | Array | - | プレイヤーリスト: [players](/docs/ja/gamepot-getplayerlist#players) |

#### `players`

`players`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `server_id` | String | - | サーバ ID |
| `deleted` | Boolean | - | プレイヤーは削除されたか - `true` \| `false` - `true`: 削除完了 - `false`: 削除されていない |
| `_id` | String | - | オブジェクト ID |
| `player_id` | String | - | プレイヤー ID |
| `project_id` | String | - | プロジェクト ID |
| `user_id` | String | - | ユーザー ID |
| `createdAt` | String | - | プレイヤー作成日時 - ISO 8601形式 |
| `id` | String | - | プレイヤー識別 ID |
| `ip` | String | - | プレイヤー IPアドレス |
| `level` | String | - | プレイヤーのレベル |
| `name` | String | - | プレイヤー名 |
| `updatedAt` | String | - | 情報更新日時 - ISO 8601形式 |
| `userdata` | String | - | ユーザーデータ(Userdata) |

参考

`_id`は、レスポンス結果に表示される場合がありますが、サービス使用に影響を与えないフィールドです。

### レスポンスステータスコード

GAMEPOT 3.0 APIで共通して使用されるレスポンスステータスコードの詳細は、[GAMEPOT 3.0のレスポンスステータスコード](/docs/ja/gamepot-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
  "totalCount": 8,
  "players": [
    {
      "server_id": "s1",
      "deleted": false,
      "_id": "68b54440c3aa0413a1f937f9",
      "player_id": "p1",
      "project_id": "85ecd393-****-****-****-d85c321772da",
      "user_id": "c6a80a22-****-****-****-9829e42730b0",
      "createdAt": "2025-09-01T06:59:12.556Z",
      "id": "2*******0f",
      "ip": "**.**.*.***",
      "level": "1",
      "name": "n1",
      "updatedAt": "2025-09-01T06:59:12.556Z",
      "userdata": "u1"
    },
    ...
  ]
}
```