List team members

Lists every active member of the team linked to the current API token.

Read-only — membership is managed in the BoxHero app. Membership is capped at 100 members per team, so the response is returned as a single unbounded {items, count} payload.

GEThttps://rest.boxhero-app.com/v1/members

Autorización

Authorizationstringobligatorio

Encabezado de autenticación Bearer con el formato Bearer <token>, donde <token> es tu token de API.

Respuestas

200Active team members.

itemsarray of Memberobligatorio

All matching resources.

Mostrar propiedades

idintegerminimum 0, maximum 2147483647obligatorio

Member id.

namestringobligatorio

Member’s display name.

rolestringobligatorio

Role within the team. admin may manage the team, members, and integrations; member may read and write inventory; viewer may read only.

Valores posiblesadminmemberviewer

countintegerminimum 0, maximum 9007199254740991obligatorio

Total number of items in items.

401Missing or invalid API token.

idstringobligatorio

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.

typestringobligatorio

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

Valores posibles/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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

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.

instancestringobligatorio

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

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 /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

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

idstringobligatorio

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.

typestringobligatorio

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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

instancestringobligatorio

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

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

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

Solicitud

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

const response = await fetch("https://rest.boxhero-app.com/v1/members", {
  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/members",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
)
data = response.json()

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

Respuesta

{
  "items": [
    {
      "id": 1001,
      "name": "John Smith",
      "role": "admin"
    },
    {
      "id": 1002,
      "name": "Jane Doe",
      "role": "member"
    },
    {
      "id": 1003,
      "name": "Mike Johnson",
      "role": "viewer"
    }
  ],
  "count": 3
}

{
  "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": "/members",
  "retryAfter": 60
}