Skip to main content
GET
List transfers

Authorizations

x-api-key
string
header
required

Your SideShift Connect API key (sk_live_* or sk_test_*). Generate from Settings → Connect.

Query Parameters

sideshiftAccountId
string

Filter to transfers involving this account (source or destination)

status
enum<string>
Available options:
pending,
completed,
failed
direction
enum<string>
Available options:
company_to_user,
user_to_company,
user_to_user
metadata[key]
string

Filter by metadata value (e.g. metadata[orderId]=order_123)

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

200 - application/json

List of transfers

success
boolean
data
object