Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-23"

Query Parameters

origin_id
string
required

The originating account ID, prefixed biz_.

query
string

Search users and accounts by name, username, or ID. Complete email addresses return no matches.

first
integer
default:20

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

Required range: x <= 100
after
string

Response

recipients listed

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