Get User List
Returns a paginated list of users matching the given filters. :param params: Filter and pagination query parameters. :param api_key: Resolved Partner API key, providing the FI scope for the lookup. :return: Paginated user list with items and pagination metadata.
Authorization
APIKeyHeader In: header
Query Parameters
Filter to the user with this partner-supplied account id.
Filter to users provisioned for this product.
Filter to users with this KYC state on their crypto account.
Filter to users with this KYC state on their securities account.
Filter to users with this KYC state on their Roth IRA account.
Filter to users with this KYC state on their robo account.
Lower bound (inclusive) on the user's created_at timestamp, UTC.
Upper bound (exclusive) on the user's created_at timestamp, UTC.
Maximum number of users to return per page.
251 <= value <= 100Cursor returned from a previous response; pass to fetch the next page.
00 <= valueSort order on sort_key. Defaults to descending (most recent first).
"desc""asc" | "desc"Field to sort the results by. Defaults to created_at.
"created_at"Response Body
application/json
application/json
curl -X GET "https://partner-api.cryptofi-dev.com/v1/users/"{
"items": [
{
"accounts": [
{
"current_market_value": "34891.00",
"kyc_approved_at": "2025-08-14T17:02:31Z",
"kyc_status": "approved",
"product": "securities"
},
{
"current_market_value": "8223.50",
"kyc_approved_at": "2025-08-14T17:02:31Z",
"kyc_status": "approved",
"product": "robo"
},
{
"current_market_value": "12450.32",
"kyc_approved_at": "2025-09-02T11:18:09Z",
"kyc_status": "approved",
"product": "crypto"
},
{
"current_market_value": "43181.03",
"kyc_status": "pending",
"product": "roth_ira"
}
],
"total_current_market_value": "98745.85",
"user_account_id": "member-001"
}
],
"total_records": 0,
"last_record_number": 0,
"per_page": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}