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.

firstinteger

Number of recipients per page. Search queries preserve the dashboard's 20-result maximum.

afterstring

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"
  }
}

Changes

Changed in 25 of the 41 revisions of this API.28

  • 9e320991dd2f1See the full diff
    • ○

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

      api-security-scope-added

  • 1b5d50d094791See the full diff
    • ○

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

      api-security-scope-added

  • 4da7133b2de71See 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

  • 85786e675f3b1See the full diff
    • ○

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

      api-security-scope-added

  • 16c82685be351See 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

  • 86d0a97abfe51See 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 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 621705ee8f4a1See 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 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e91d507bda451See the full diff
    • ○

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

      api-security-scope-added

  • 42ce5c13e53b1See 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

  • 7e118b4466cd1See the full diff
    • ○

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

      api-security-scope-added