Sign in
Transfers

List Transfer Recipients

Lists the people and accounts you can send money to.

get/transfers/recipients

Query parameters

origin_idstring required

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

querystring

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.

firstinteger

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

afterstring

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

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": {
    "start_cursor": "MQ"
  }
}

Changes

Changed in 56 of the 74 revisions of this API.59

  • 78e1ed7366cd1See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

  • 73dd0533cd811See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

  • 86b97292852d1See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

  • c1dceb26e5051See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

  • 7fcefabddb0a1See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99661See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

  • 35edb053220a1See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ac2b9b1c6a001See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

  • a88353507eac1See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

  • 51933d70d7f51See the full diff
    • ○

      the security scope company:authorized_user:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

Of the 74 revisions, 1 has no diff computed.