Skip to main content
GET
List Secured Accounts

Authorizations

Authorization
string
header
required

Your secret API key (bs_dev_… for development, bs_production_… for production), or a site key (pk_test_… / pk_live_…) when calling from an allowed origin. Create keys in the Console under Settings → Developer Tools.

Query Parameters

platform_user_ref
string

Your stable user id for the account (the same platform_user_ref you passed when it was secured). Hashed server-side; never stored or returned.

Maximum string length: 512
status
enum<string>

Omit for both.

Available options:
active,
unlinked
limit
integer

Page size. Default 25, max 100.

Required range: 1 <= x <= 100
offset
integer

Default 0.

Required range: x >= 0

Response

One page of Secured Accounts. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: api_key_required / invalid_api_key (401), partner_not_found (403), invalid_platform_user_ref / invalid_status (400), secured_accounts_unavailable (500).

data
object
required