Get a team member

Returns a single team member by id.

GEThttps://rest.boxhero-app.com/v1/members/{member_id}

Autorisation

Authorizationstringobligatoire

En-tête d’authentification Bearer au format Bearer <token>, où <token> est votre jeton d’API.

Paramètres de chemin

member_idintegerminimum 0, maximum 2147483647obligatoire

Réponses

200The requested member.

itemMemberobligatoire

A member of the team.

Afficher les propriétés

idintegerminimum 0, maximum 2147483647obligatoire

Member id.

namestringobligatoire

Member’s display name.

rolestringobligatoire

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

Valeurs possiblesadminmemberviewer

401Missing or invalid API token.

idstringobligatoire

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.

typestringobligatoire

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

Valeurs possibles/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

titlestringobligatoire

Human-readable summary of the error, in English.

correlationIDstringobligatoire

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.

instancestringobligatoire

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.

Afficher les propriétés

patharray of string | numberobligatoire

messagestringobligatoire

404No member with the given id was found in this team.

idstringobligatoire

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.

typestringobligatoire

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

titlestringobligatoire

Human-readable summary of the error, in English.

correlationIDstringobligatoire

instancestringobligatoire

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.

Afficher les propriétés

patharray of string | numberobligatoire

messagestringobligatoire

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

idstringobligatoire

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.

typestringobligatoire

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

titlestringobligatoire

Human-readable summary of the error, in English.

correlationIDstringobligatoire

instancestringobligatoire

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.

Afficher les propriétés

patharray of string | numberobligatoire

messagestringobligatoire

Requête

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

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

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

Réponse

{
  "item": {
    "id": 1001,
    "name": "John Smith",
    "role": "admin"
  }
}

{
  "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/not-found",
  "title": "No member with the given id was found in this team.",
  "instance": "/members/12345"
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/members/12345",
  "retryAfter": 60
}