Skip to content

GET /v3/auction/{auctionId}/facets — filter options the auction can satisfy

GET
/v3/auction/{auctionId}/facets
curl --request GET \
--url https://api-ha-prod-p8.handbid.dev/v3/auction/33934/facets \
--header 'Authorization: Bearer <token>'

What the auction actually contains, so a client offers only filters that return something (HAN-2555): {itemTypes[], customFields[], priceBounds{min,max}}. type values are raw items.itemType tokens — anything advertised narrows the /items itemType filter to ≥1 item. Auction-global, not filter-reactive — counts describe the auction, not the caller’s current filter set, so options never vanish or renumber as a user narrows; do not render a count beside an option while other filters are active. Not web_app-gated.

Auth: optional (identity-free; token feeds the gate + auctionFacets limiter).

auctionId
required
integer
Example
33934

Facet options (itemTypes, customFields, priceBounds).

Media type application/json
object
Example generated
{}

Private event — invitation code required (private_event_pin_required); exchange it at the access route.

Media type application/json

Unified error envelope. retryAfter is present only on transient (429 / 503) responses.

object
error
required

Stable machine-readable error code (e.g. unauthorized, forbidden, not_found, validation_error, unavailable).

string
message
required

Human-readable explanation.

string
retryAfter

Seconds to wait before retrying. Present on 429 and 503.

integer
Example generated
{
"error": "example",
"message": "example",
"retryAfter": 1
}

Not found (unknown id/key, or a privacy-blocked auction — a 403 would assert existence).

Media type application/json

Unified error envelope. retryAfter is present only on transient (429 / 503) responses.

object
error
required

Stable machine-readable error code (e.g. unauthorized, forbidden, not_found, validation_error, unavailable).

string
message
required

Human-readable explanation.

string
retryAfter

Seconds to wait before retrying. Present on 429 and 503.

integer
Example generated
{
"error": "example",
"message": "example",
"retryAfter": 1
}

Rate limited; Retry-After seconds.

Media type application/json

Unified error envelope. retryAfter is present only on transient (429 / 503) responses.

object
error
required

Stable machine-readable error code (e.g. unauthorized, forbidden, not_found, validation_error, unavailable).

string
message
required

Human-readable explanation.

string
retryAfter

Seconds to wait before retrying. Present on 429 and 503.

integer
Example generated
{
"error": "example",
"message": "example",
"retryAfter": 1
}