> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Every page is available as Markdown by appending `.md` to its URL; this page is [Markdown](https://www.boxhero.io/docs/ja/developers/api/reference/teams/get-linked-team.md).

# Get the linked team

> Returns metadata for the team that owns the current API token (id, name, currency, mode).

Use this to confirm the token's tenant and to check whether the team is in LOCATION mode.

`GET https://rest.boxhero-app.com/v1/teams/linked`

## 認証

- `Authorization` (string, 必須): `Bearer <token>` 形式の Bearer 認証ヘッダーです。`<token>` には [APIトークン](https://www.boxhero.io/docs/ja/developers/api/authentication) を指定します。

## レスポンス

**200** The linked team.

- `id` (integer, minimum 0, maximum 2147483647, 必須): Team id.
- `name` (string, 必須): Display name of the team.
- `mode` (number, 必須): Team mode. The Open API requires LOCATION mode (`mode = 2`); other modes return `400` on most endpoints. (`0` = BASIC, `1` = ADVANCED/Unit, `2` = LOCATION.)

  指定可能な値: `0`, `1`, `2`
- `currency_symbol` (string, nullable, 必須): Resolved currency symbol used for cost and price. If `currency_code` is set, this is derived from the ISO 4217 currency metadata; otherwise it falls back to the team's legacy currency symbol. Nullable.
- `currency_code` (string, nullable, 必須): ISO 4217 team currency code. Legacy teams that have not opted into currency-code settings return `null`.
- `price_decimal_places` (integer, minimum 0, maximum 10, 必須): Effective price decimal places. Resolution order: explicit team override, ISO 4217 currency minor-unit digits, then legacy currency-symbol fallback.
- `memo` (string, nullable, 必須): Free-text team memo. Nullable.

**401** Missing or invalid API token.

- `id` (string, 必須): Unique exception id (`ex_` followed by 32 lowercase hex chars, no dashes — e.g. `ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a`). Quote this in support tickets so we can find the request in our logs.
- `type` (string, 必須): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  指定可能な値: `/errors/not-found`, `/errors/invalid-request`, `/errors/invalid-team-mode`, `/errors/tokens/invalid`, `/errors/tokens/required`, `/errors/too-many-requests`, `/errors/core/usage-limit-exceeded`, `/errors/core/forbidden`, `/errors/core/unhandled`, `/errors/unhandled`
- `title` (string, 必須): Human-readable summary of the error, in English.
- `correlationID` (string, 必須): Request correlation id (`rq_` followed by 32 lowercase hex chars, no dashes — e.g. `rq_01abf3...`). Identical to the `X-Correlation-Id` response header. Pass an `X-Correlation-Id` request header to thread your trace through to ours.
- `instance` (string, 必須): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `code` (string): Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. `not-available-for-api-token` on 403). Use this for fine-grained branching after dispatching on `type`.
- `errors` (array of object): Field-level error details. Present on `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, 必須)
  - `message` (string, 必須)

**429** Rate limit exceeded. Check `RateLimit`, `Retry-After`, and `X-RateLimit-*` response headers before retrying.

- `id` (string, 必須): Unique exception id (`ex_` followed by 32 lowercase hex chars, no dashes — e.g. `ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a`). Quote this in support tickets so we can find the request in our logs.
- `type` (string, 必須): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  指定可能な値: `/errors/not-found`, `/errors/invalid-request`, `/errors/invalid-team-mode`, `/errors/tokens/invalid`, `/errors/tokens/required`, `/errors/too-many-requests`, `/errors/core/usage-limit-exceeded`, `/errors/core/forbidden`, `/errors/core/unhandled`, `/errors/unhandled`
- `title` (string, 必須): Human-readable summary of the error, in English.
- `correlationID` (string, 必須): Request correlation id (`rq_` followed by 32 lowercase hex chars, no dashes — e.g. `rq_01abf3...`). Identical to the `X-Correlation-Id` response header. Pass an `X-Correlation-Id` request header to thread your trace through to ours.
- `instance` (string, 必須): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `code` (string): Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. `not-available-for-api-token` on 403). Use this for fine-grained branching after dispatching on `type`.
- `errors` (array of object): Field-level error details. Present on `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, 必須)
  - `message` (string, 必須)

リクエスト

**cURL**

```bash
curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/teams/linked' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"
```

**JavaScript**

```javascript
const response = await fetch("https://rest.boxhero-app.com/v1/teams/linked", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
  },
});
const data = await response.json();
```

**Python**

```python
import os
import requests

response = requests.get(
    "https://rest.boxhero-app.com/v1/teams/linked",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
)
data = response.json()
```

**HTTP**

```http
GET /v1/teams/linked HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
```

レスポンス

**200**

```json
{
  "id": 149058,
  "name": "Acme Retail",
  "mode": 2,
  "currency_symbol": "$",
  "currency_code": "USD",
  "price_decimal_places": 2,
  "memo": null
}
```

**401**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}
```

**429**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/teams/linked",
  "retryAfter": 60
}
```