Sign in
Auctions

Search Auctions for administration

Changed on

Administrator authority is required. Delegated Aura access tokens also require auctions:read; Cognito users do not require a delegated scope. Success and errors are always no-store.

get/api/v1/admin/auctions

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/admin/auctions
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

querystring

NUL-free, case-insensitive literal substring of the localized Auction name or sourceAuctionId.

listingSourceIdstring
sourceAuctionIdstring

Exact source-scoped Auction key, trimmed as on create. Combine with listingSourceId to locate a create conflict.

format'LIVE' | 'TIMED'
reportedStatus'SCHEDULED' | 'IN_PROGRESS' | 'ENDED' | 'POSTPONED' | 'CANCELLED'
sort'name' | 'created' | 'updated'

Supply both sort and order to override the default updated/descending ordering.

order'asc' | 'desc'

Supply both sort and order to override the default updated/descending ordering.

sizeinteger

Requested page limit, clamped to 1–100.

searchAfterstring

Opaque cursor from the preceding page. Filters, sort and order must match the request that issued it.

Response

All matching Auctions, regardless of status or visible listing count. Always Cache-Control: no-store.

sizeinteger required

Number of items returned on this page.

searchAfterstring

Opaque cursor, omitted on the terminal page.

Example response

{
  "items": [
    {
      "name": {
        "language": "de"
      }
    }
  ]
}

Changes