f1cf47ad0ec2
List Transfer Recipients
Lists the people and accounts you can send money to.
Query parameters
The account sending the money: a company account ID (biz_), or a user ID (user_) for that user's own personal balance.
Search anyone on Whop by name or username, plus your own accounts by name or ID. 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.
Number of recipients per page. Search queries preserve the dashboard's 20-result maximum.
Cursor to fetch the page after (from page_info.end_cursor).
Response
recipients listed
Example response
{
"data": [
{
"id": "user_xxxxxxxxxxxxxx",
"name": "Dana Whitfield",
"object": "user",
"profile_picture_url": "https://ui-avatars.com/api/",
"username": "danawhitfield"
}
],
"page_info": {
"end_cursor": "Mg",
"start_cursor": "MQ"
}
}