Documentation > Resources > Bidders

Bidders API

A bidder is a user registered for a specific sale.

The Bidders API is restricted to authorized applications/users.

Retrieving Bidders

Users can retrieve bidders by following the bidders link from root.

curl -v "" -H "X-Access-Token:..."

This endpoint accepts the following parameters.

Name Value
sale_id Applicable Auction (sale) ID.

The response is a paginated result with embedded bidders.

  "total_count" : 1,
  "_links" : {
    "self" : {
      "href" : ""
    "next" : {
      "href" : ""
  "_embedded" : {
    "bidders" : [

A request without a sale_id will receive a paginated list of all bidders.

Retrieving a Bidder

Authorized users and applications can retrieve a specific bidder by ID by rendering the "bidder" link template from root.

curl -v "{id}" -H "X-XAPP-Token:..."

Bidder JSON Format

Key Description
id Unique id.
qualified_for_bidding Whether or not the bidder is qualified to bid.
created_at Timestamp of when the record was created.
updated_at Timestamp of when the record was last updated.


Key Target
self The bidder resource.
sale The sale of the bidder
user The user of the bidder
user_detail The user detail of the bidder