Zum Inhalt springen

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.

GEThttps://rest.boxhero-app.com/v1/teams/linked
Authorizationstringerforderlich

Bearer-Authentifizierungsheader im Format Bearer <token>, wobei <token> Ihr API-Token ist.

200The linked team.
idintegerminimum 0, maximum 2147483647erforderlich

Team id.

namestringerforderlich

Display name of the team.

modenumbererforderlich

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.)

Mögliche Werte012

currency_symbolstringnullableerforderlich

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_codestringnullableerforderlich

ISO 4217 team currency code. Legacy teams that have not opted into currency-code settings return null.

price_decimal_placesintegerminimum 0, maximum 10erforderlich

Effective price decimal places. Resolution order: explicit team override, ISO 4217 currency minor-unit digits, then legacy currency-symbol fallback.

memostringnullableerforderlich

Free-text team memo. Nullable.

401Missing or invalid API token.
idstringerforderlich

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.

typestringerforderlich

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

titlestringerforderlich

Human-readable summary of the error, in English.

correlationIDstringerforderlich

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.

instancestring

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.

codestring

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.

errorsarray 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.

Eigenschaften anzeigen
patharray of string | numbererforderlich
messagestringerforderlich
429Rate 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.
idstringerforderlich

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.

typestringerforderlich

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

titlestringerforderlich

Human-readable summary of the error, in English.

correlationIDstringerforderlich

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.

instancestring

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.

codestring

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.

errorsarray 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.

Eigenschaften anzeigen
patharray of string | numbererforderlich
messagestringerforderlich

Anfrage

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

Antwort

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