# Organization API: Customer Portal: Players

> The 2 Organization API operations for players.

Source: https://www.coritan.com/docs/api/reference/organizations/customer-portal/players/

Part of [Customer Portal](/docs/api/reference/organizations/customer-portal/).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/orgs/{org_slug}/portal/players`](#op-get-api-v1-orgs-org-slug-portal-players) | List my players |
| POST | [`/api/v1/orgs/{org_slug}/portal/players`](#op-post-api-v1-orgs-org-slug-portal-players) | Remember my player |

### List my players {#op-get-api-v1-orgs-org-slug-portal-players}

`GET /api/v1/orgs/{org_slug}/portal/players`

The Minecraft players the signed-in customer bought for or named, the most recent
first, at most 20. Typing one of these names into the sign-in form sends the code to
this customer, unless another customer used the name more recently.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `org_slug` | path | string | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

Fields of a `200` response:

| Field | Type | Description |
| --- | --- | --- |
| `players` | array of PlayerOut | The most recent first, at most 20. |
| `players[].name` | string | As the game shows it. |
| `players[].edition` | string | `java`, `java_offline` or `bedrock`. |
| `players[].uuid` | string or null | Lowercase with dashes, or `null` when we have none. |
| `players[].last_used_at` | string or null | When the customer last bought for or named the player, in UTC. |

### Remember my player {#op-post-api-v1-orgs-org-slug-portal-players}

`POST /api/v1/orgs/{org_slug}/portal/players`

Remember a Minecraft player for the signed-in customer, such as the one they named
in the sign-in dialog. A name they already have is updated in place, in any case: the
edition, the UUID when one is sent, and the time it was last used. The answer is the
player as ``GET /portal/players`` lists it. 422 for a name the game does not allow, an
edition other than ``java``, ``java_offline`` or ``bedrock``, or a UUID that is not one.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | The player's name as the game shows it, with the edition's prefix when it has one. |
| `edition` | string | yes | `java`, `java_offline` or `bedrock`. |
| `uuid` | string or null | no | The player's UUID, when `GET /network/players/lookup` found one: 32 hexadecimal digits, with or without dashes. |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

Fields of a `200` response:

| Field | Type | Description |
| --- | --- | --- |
| `player` | PlayerOut |  |
| `player.name` | string | As the game shows it. |
| `player.edition` | string | `java`, `java_offline` or `bedrock`. |
| `player.uuid` | string or null | Lowercase with dashes, or `null` when we have none. |
| `player.last_used_at` | string or null | When the customer last bought for or named the player, in UTC. |
