List partners

Returns a cursor-paginated list of partners (suppliers and customers).

Items are ordered by id ascending (legacy wire-compat). Pass type=0 for suppliers only or type=1 for customers only.

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

การยืนยันสิทธิ์

Authorizationstringจำเป็น

เฮดเดอร์การยืนยันตัวตนแบบ Bearer ในรูปแบบ Bearer <token> โดย <token> คือ โทเค็น API ของคุณ

พารามิเตอร์ของคิวรี

typeintegerminimum 0, maximum 1

Filter by partner type. Pass 0 for suppliers only or 1 for customers only. Omit to list both.

cursorintegerminimum 0, maximum 2147483647

Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call.

limitintegerminimum 1, maximum 100

Page size. Accepts 1–100; defaults to 100.

การตอบกลับ

200A page of partners.

itemsarray of Partnerจำเป็น

Items in this page. Default ordering is by id ascending; see the resource’s list endpoint description for any per-resource overrides.

แสดงพร็อพเพอร์ตี

idintegerminimum 0, maximum 2147483647จำเป็น

Partner id.

typenumberจำเป็น

Partner classification. 0 = supplier (used in Stock In transactions), 1 = customer (used in Stock Out transactions).

ค่าที่เป็นไปได้01

namestringจำเป็น

Partner display name.

phonestringจำเป็น

Phone number. Empty string when not set.

emailstringจำเป็น

Email address. Empty string when not set.

addressstringจำเป็น

Postal address. Empty string when not set.

memostringจำเป็น

Free-text memo. Empty string when not set.

countintegerminimum 0, maximum 9007199254740991จำเป็น

Number of items in this page (items.length).

limitintegerminimum 0, maximum 9007199254740991จำเป็น

Page size used to build this response.

cursorintegerminimum 0, maximum 2147483647, nullableจำเป็น

Cursor to pass as cursor in the next request. null when has_more is false.

has_morebooleanจำเป็น

True when another page is available. The cursor is monotonic — pass it as cursor on the next request to advance the page. Direction follows each resource’s ordering (default: id ascending).

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. Pass an X-Correlation-Id request header to thread your trace through to ours.

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

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

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.

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

คำขอ

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

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

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

การตอบกลับ

{
  "items": [
    {
      "id": 431485,
      "type": 0,
      "name": "Acme Supply Co.",
      "phone": "+1-415-555-0101",
      "email": "orders@acme-supply.example.com",
      "address": "123 Market St, San Francisco, CA 94103",
      "memo": ""
    },
    {
      "id": 431488,
      "type": 1,
      "name": "Northwind Retail",
      "phone": "",
      "email": "buyer@northwind.example.com",
      "address": "",
      "memo": ""
    }
  ],
  "count": 2,
  "limit": 100,
  "cursor": 431488,
  "has_more": false
}

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