Skip to main content
GET
Search account records

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

company:basic:read
member:basic:read
payment:basic:read
affiliate:basic:read
payment:resolution_center_case:read
promo_code:basic:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Queryparameters

query
string
vereist

Text to search for, 2 to 250 characters.

types
enum<string>[]

Kinds of records to search. Defaults to every kind. account rows are account_id itself and, with include_subaccounts, its subaccounts.

Beschikbare opties:
account,
member,
membership,
payment,
affiliate,
review,
resolution_center_case,
promo_code
account_id
string
vereist

The account to search, prefixed biz_. Records other than accounts belong to it, or with include_subaccounts to its subaccounts. Your credential needs read access to at least one kind of record on it that search returns, or the account is a 404.

include_subaccounts
boolean

true also searches the subaccounts of a platform account_id: an ID, an email, card digits or a phone number finds their records, and the subaccounts themselves are found as account rows by name, ID or store link, or by the email of their owner, a team member or a customer. Safe to send for any account: one without subaccounts is searched as if this were false.

first
integer
standaard:20

Number of results to return from the start of the range.

Vereist bereik: x <= 100

Respons

Search results: identifier matches first, then ranked rows, best match first.

data
object[]
vereist
page_info
object
vereist