Skip to content
Handbid Developers

GET /v3/auctions/by-key/{key} — auction detail by key

GET
/v3/auctions/by-key/{key}
 
curl --request GET \
  --url https://api-ha-prod-p8.handbid.dev/v3/auctions/by-key/spring-gala \
  --header 'Authorization: Bearer <token>'

Web deep-link sibling of GET /v3/auctions/{id} (HAN-2477). Resolves auctions.key to an id, then returns the same detail body, the same privacy gate, and the same web_app=true body switch as the numeric-id route — including the always-present top-level entitlements block (HAN-2769). auctionDetailByKey is rate-limited separately from auctionDetail.

Auth: optional Bearer (opportunistic — flips per-caller isFavorite; missing/invalid degrades to anonymous).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
key
required
string
Example 
spring-gala

Query Parameters

Section titled “Query Parameters ”
whitelabelKey
string

Whitelabel slug; wins over whitelabelId when both are sent.

whitelabelId
integer

Numeric whitelabel scope (native callers).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Auction detail (same shape as /v3/auctions/{id}).

Media type application/json
object
Example generated
{}

403

Section titled “403 ”

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
}

404

Section titled “404 ”

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
}

429

Section titled “429 ”

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
}