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.
https://rest.boxhero-app.com/v1/teams/linkedAutorisierung
Abschnitt betitelt „Autorisierung“Bearer-Authentifizierungsheader im Format Bearer <token>, wobei <token> Ihr API-Token ist.
Antworten
Abschnitt betitelt „Antworten“200The linked team.
Team id.
Display name of the team.
Team mode. The Open API requires LOCATION mode (mode = 2); other modes return 400 on most endpoints. (0 = BASIC, 1 = ADVANCED/Unit, 2 = LOCATION.)
Mögliche Werte012
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.
ISO 4217 team currency code. Legacy teams that have not opted into currency-code settings return null.
Effective price decimal places. Resolution order: explicit team override, ISO 4217 currency minor-unit digits, then legacy currency-symbol fallback.
Free-text team memo. Nullable.
401Missing or invalid API token.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Mögliche Werte/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Eigenschaften anzeigen
429Rate limit exceeded. Check RateLimit, Retry-After, and X-RateLimit-* response headers before retrying.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Mögliche Werte/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Eigenschaften anzeigen
Anfrage
curl --request GET \ --url 'https://rest.boxhero-app.com/v1/teams/linked' \ --header "Authorization: Bearer $BOXHERO_API_TOKEN"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();import osimport requests
response = requests.get( "https://rest.boxhero-app.com/v1/teams/linked", headers={ "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"], },)data = response.json()GET /v1/teams/linked HTTP/1.1Host: rest.boxhero-app.comAuthorization: Bearer <token>Antwort
{ "id": 149058, "name": "Acme Retail", "mode": 2, "currency_symbol": "$", "currency_code": "USD", "price_decimal_places": 2, "memo": null}{ "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"}{ "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a", "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2", "type": "/errors/too-many-requests", "title": "Too many requests.", "instance": "/teams/linked", "retryAfter": 60}