Skip to main content
GET
TypeScript

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an App API key, 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

payout:withdraw_funds
company:authorized_user:read

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Forespørgselsparametre

origin_id
string
påkrævet

The account sending the money: an account ID (biz_), or a user ID (user_) for that user's own personal balance.

query
string

Search anyone on Whop by name or username, plus your own accounts by name or ID. An exact account ID (biz_), user ID (user_), or username returns that recipient first. An ID or an @username returns only that recipient. Omit it to get the team around the balance, the people you follow, and your own accounts. The list is the same whether the balance belongs to an account or to you. Searching from a biz_ origin additionally requires the member:basic:read scope. A credential scoped to a single account is the exception to the search itself: it only ever sees that account's own people. Complete email addresses return no matches. Search results are limited to 20 recipients.

first
integer
standard:20

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

Nødvendigt interval: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

Svar

recipients listed

data
(TransferRecipientUser · object | TransferRecipientAccount · object)[]
påkrævet
page_info
object
påkrævet