List Business Users

get

https://sandbox-api.transfi.com/v3/users/business

Retrieve a paginated list of business users with optional filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

Page number

limit

integer

1 to 100

Defaults to 5

Number of users per page

userId

string

Filter by business user ID (exact match)

string

Filter by business email

phone

string

Filter by business phone

accountType

string

enum

Filter by account role. sender returns sender accounts; recipient_fiat / recipient_crypto return users with at least one fiat / crypto account identifier. Applies only to users created through the sender or recipient creation APIs.

Allowed:

accountIdentifierValue

string

length between 1 and 100

Filter by the value of a payout account identifier, such as a bank account number or a wallet address. Exact match. Applies only to users created through the sender or recipient creation APIs.

accountIdentifierType

string

enum

Filter by the type of a payout account identifier. When combined with accountIdentifierValue, both must match the same account identifier entry. Applies only to users created through the sender or recipient creation APIs.

Allowed:

Headers

MID

string

required

Merchant or sub-merchant MID

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Business users retrieved successfully

400Invalid request parameters

500Internal server error