Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-22-4"

Query Parameters

origin_id
string
required

The account sending the money: a company 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 business ID (biz_) returns that business first. 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 a company or to you. Searching from a biz_ origin additionally requires the member:basic:read scope. A credential scoped to a single company is the exception to the search itself: it only ever sees that company's own people. Complete email addresses return no matches. Search results are limited to 20 recipients.

first
integer
default:20

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

Required range: x <= 100
after
string

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

Response

recipients listed

data
(TransferRecipientUser · object | TransferRecipientAccount · object)[]
required
page_info
object
required