> 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/th/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 ในรูปแบบ `Bearer <token>` โดย `<token>` คือ [โทเค็น API](https://www.boxhero.io/docs/th/developers/api/authentication.md) ของคุณ

## การตอบกลับ

**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 items, locations, transactions, bundles, purchase orders, sales orders, and returns. Team, members, partners, item attributes, price lists, and webhooks work in any mode. (`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. A client-supplied `X-Correlation-Id` request header (at most 128 chars of `A-Z a-z 0-9 . _ : / = -`) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated `rq_…` id.
- `instance` (string): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix. Absent on unknown-path `404` and unexpected `500` responses.
- `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 request-validation `/errors/invalid-request` (400) responses. Absent on malformed-JSON `400`, `413` body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include `403`). 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. Limits are per team and shared by all of the team's API tokens: 5 requests per second and 300 requests per minute. The `RateLimit` and `X-RateLimit-*` headers reflect the per-minute window; check them and `Retry-After` before retrying. This status is also returned when the client IP exceeds 30 failed authentication attempts within 60 seconds, even if the token is valid.

- `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. A client-supplied `X-Correlation-Id` request header (at most 128 chars of `A-Z a-z 0-9 . _ : / = -`) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated `rq_…` id.
- `instance` (string): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix. Absent on unknown-path `404` and unexpected `500` responses.
- `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 request-validation `/errors/invalid-request` (400) responses. Absent on malformed-JSON `400`, `413` body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include `403`). 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_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "instance": "/teams/linked",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}
```

**429**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/teams/linked",
  "retryAfter": 60
}
```