List attribute specs

Lists every custom attribute spec defined for the team, sorted by rank ascending.

File-type attributes are excluded.

GEThttps://rest.boxhero-app.com/v1/item-attrs

授權

Authorizationstring必填

Bearer <token> 格式的 Bearer 驗證標頭，其中 <token> 為您的 API 權杖。

回應

200All attribute specs.

itemsarray of Attr必填

All matching resources.

顯示屬性

idintegerminimum 0, maximum 2147483647必填

Attribute spec id.

attr_typestring必填

Value type accepted by this attribute. text accepts any string; date accepts an ISO-8601 date (YYYY-MM-DD); number accepts a JSON number; barcode accepts a barcode string. File-type attributes exist in the BoxHero app but cannot be queried or set via the Open API.

可能的值textdatenumberbarcode

attr_namestring必填

Display name of the attribute.

ranknumber必填

Sort order shown in the BoxHero app. Lower values appear first; ties are broken by id. Ranks need not be contiguous.

countintegerminimum 0, maximum 9007199254740991必填

Total number of items in items.

401Missing or invalid API token.

idstring必填

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.

typestring必填

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

titlestring必填

Human-readable summary of the error, in English.

correlationIDstring必填

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.

顯示屬性

patharray of string | number必填

messagestring必填

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.

idstring必填

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.

typestring必填

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

titlestring必填

Human-readable summary of the error, in English.

correlationIDstring必填

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

errorsarray of object

顯示屬性

patharray of string | number必填

messagestring必填

請求

curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/item-attrs' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"

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

import os
import requests

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

GET /v1/item-attrs HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>

回應

{
  "items": [
    {
      "id": 412746,
      "attr_type": "text",
      "attr_name": "Category",
      "rank": 0
    },
    {
      "id": 485697,
      "attr_type": "text",
      "attr_name": "Brand",
      "rank": 1
    },
    {
      "id": 485086,
      "attr_type": "number",
      "attr_name": "Minimum Stock",
      "rank": 2
    },
    {
      "id": 413101,
      "attr_type": "date",
      "attr_name": "Expiration Date",
      "rank": 3
    }
  ],
  "count": 4
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "instance": "/item-attrs",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/item-attrs",
  "retryAfter": 60
}