List all buyers or search for a specific buyer.
This endpoint requires the buyers.read
scope. The buyers.billing-details.read
scope is needed to see all personally identifiable information.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The ID of the merchant account to use for this request.
"default"
A pointer to the page of results to return.
"ZXhhbXBsZTE"
The maximum number of items that are at returned.
1 <= x <= 100
20
Filters the results to only the buyers for which the display_name
or external_identifier
matches this value.
"John"
Filters the results to only the buyers for which the external_identifier
matches this value.
"buyer-12345"
Successful Response
The response is of type object
.