List buyers
Returns a list of buyers.
This endpoint requires the buyers.read
scope. The buyers.billing-details.read
scope is needed to see all personally identifiable information.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Please do not use this query parameter in a production application, as this API call is very inefficient and may negatively impact transaction performance.
Filters the results to only the buyers for which the display_name
, email_address
or external_identifier
matches this value. This field allows for a case insensitive
partial match, matching any buyer for which any of the fields partially or
completely matches.
Filters the results to only the items for which the buyer
has an
external_identifier
that exactly matches this value.
Defines the maximum number of items to return for this request.
1 < x < 100
A cursor that identifies the page of results to return. This is used to paginate the results of this API.
For the first page of results, this parameter can be left out.
For additional pages, use the value returned by the API in
the next_cursor
field. Similarly the previous_cursor
can be used to
reverse backwards in the list.
Response
A list of buyers.
A list of buyers.
The limit applied to request. This represents the number of items that are at maximum returned by this request.
1 < x < 100
The cursor that represents the next page of results. Use the cursor
query
parameter to fetch this page of items.
1 - 1000
The cursor that represents the next page of results. Use the cursor
query
parameter to fetch this page of items.
1 - 1000
Was this page helpful?