Get auction bids

GEThttps://admin.snagsolutions.io/api/auction_bids

Returns a list of auction bids with optional filtering and pagination.

Loading code example

Loading code example

Authorizations

apiKeyAuthstringheaderrequired

API key passed in the header.

Query Parameters

idany

The bid ID(s) - accepts a single ID or an array of IDs

userIdstring<uuid>

ID of the user who made the bid

walletAddressstring

Wallet address of the bidder

startingAfterstring<uuid>

Pagination cursor to start after a specific bid ID

limitinteger

Maximum number of bids to return

Required range: x >= 1, x <= 1000

organizationIdstring<uuid>

ID of the organization

websiteIdstring<uuid>

ID of the website

auctionIdstring<uuid>

ID of the auction

status"submitted" | "accepted" | "rejected" | "fulfilled"

Status of the bid

Allowed values: "submitted" | "accepted" | "rejected" | "fulfilled"

orderBy"asc" | "desc"

Order bids by amount (ascending or descending). Defaults to desc.

Allowed values: "asc" | "desc"

skipinteger

Number of bids to skip (for offset-based pagination)

Required range: x >= 0

includeCountboolean

Include total count of matching bids in response

statusesarray<"submitted" | "accepted" | "rejected" | "fulfilled">

Filter by multiple bid statuses (OR condition)

Response

application/json

200

dataarray<object>required

data.idstring<uuid>required

data.amountany

data.status"submitted" | "accepted" | "rejected" | "fulfilled"required

Allowed values: "submitted" | "accepted" | "rejected" | "fulfilled"

data.auctionIdstring<uuid>required

data.auctionItemIdstring<uuid>required

data.currencyAddressstringrequired

data.currencyDecimalsnumberrequired

data.updatedAtstring<date-time>required

data.auctionItemobjectrequired

data.userobjectrequired

data.loyaltyCurrencyobjectrequired

data.auctionobjectrequired

hasNextPagebooleanrequired

Indicates if there is a next page of results

countnumber

Total count of matching bids (only present when includeCount=true)