List Auction Items

Returns a paginated list of auction items.

get

Authorizations

AuthorizationstringRequired

You can retrieve your token by visiting Settings > API and clicking Generate API token.

Query parameters

filter[status]string · enumOptionalPossible values:

filter[eventId]stringOptional

perPageinteger · min: 1 · max: 100Optional

Results per page (1–100).

fields[auction-items]stringOptional

Available values are startPrice, reservePrice, bidIncrementStrategy, automaticBidding, softClose, totalBids, highBidAmount, minimumBid, currentIncrement, startsAt, endsAt, position, status, reserveMet, canceledAt, archivedAt, processed, createdAt, updatedAt. You can include multiple values by separating them with a comma.

fields[variants]stringOptional

Available values are externalId, displayName, title, price, photoUrl, sku. You can include multiple values by separating them with a comma.

fields[products]stringOptional

Available values are externalId, title, vendor, type, photoUrl, handle. You can include multiple values by separating them with a comma.

fields[bids]stringOptional

Available values are amount, placedAt, automatic. You can include multiple values by separating them with a comma.

fields[customers]stringOptional

Available values are name, firstName, lastName, externalId, email, registeredAt, approvedAt, bannedAt, createdAt. You can include multiple values by separating them with a comma.

fields[auction-winners]stringOptional

Available values are amount, notifiedAt, paymentDueAt, paid, externalOrderId. You can include multiple values by separating them with a comma.

fields[max-bids]stringOptional

Available values are amount, createdAt. You can include multiple values by separating them with a comma.

includestringOptional

Comma-separated list of related resources to include in the response. Available values: variant, product, highBid, highBid.customer, maxBid, winner, winner.customer.

sortstringOptional

Sort by field. Prefix with - for descending order. Available values: endsAt, -endsAt, totalBids, -totalBids.

Responses

200

Paginated set of AuctionItemResource

application/vnd.api+json

401

Unauthenticated

application/vnd.api+json

422

Validation error

application/vnd.api+json

get/auction-items

GET /v1/auction-items HTTP/1.1
Host: api.auctionplusapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "cv4bpx1j2568d4pj8nhs21gjpm",
      "type": "auction-items",
      "attributes": {
        "startPrice": {
          "value": 100,
          "major": "1.00",
          "display": "$1.00",
          "currency": "USD"
        },
        "reservePrice": {
          "value": 1000,
          "major": "10.00",
          "display": "$10.00",
          "currency": "USD"
        },
        "bidIncrementStrategy": {
          "strategy": "fixed_amount",
          "value": {
            "amount": {
              "value": 500,
              "major": "5.00",
              "display": "$5.00",
              "currency": "USD"
            }
          }
        },
        "automaticBidding": {
          "enabled": true
        },
        "softClose": {
          "enabled": false,
          "extendFrom": null,
          "extendDuration": null
        },
        "totalBids": 1,
        "highBidAmount": {
          "value": 5000,
          "major": "50.00",
          "display": "$50.00",
          "currency": "USD"
        },
        "minimumBid": {
          "value": 5500,
          "major": "55.00",
          "display": "$55.00",
          "currency": "USD"
        },
        "currentIncrement": {
          "value": 500,
          "major": "5.00",
          "display": "$5.00",
          "currency": "USD"
        },
        "startsAt": "2026-07-29T18:29:55.000000Z",
        "endsAt": "2026-07-29T19:29:55.000000Z",
        "position": null,
        "status": "active",
        "reserveMet": true,
        "canceledAt": null,
        "archivedAt": null,
        "processed": false,
        "createdAt": "2026-07-29T18:29:55.000000Z",
        "updatedAt": "2026-07-29T18:29:55.000000Z"
      },
      "relationships": {
        "variant": {
          "data": {
            "type": "variants",
            "id": "text"
          }
        },
        "product": {
          "data": {
            "type": "products",
            "id": "text"
          }
        },
        "highBid": {
          "data": {
            "type": "bids",
            "id": "text"
          }
        },
        "winner": {
          "data": {
            "type": "auction-winners",
            "id": "text"
          }
        },
        "maxBid": {
          "data": {
            "type": "max-bids",
            "id": "text"
          }
        }
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "from": null,
    "lastPage": 1,
    "perPage": 1,
    "to": null,
    "total": 1
  },
  "included": [
    {
      "id": "text",
      "type": "text",
      "attributes": {
        "externalId": null,
        "displayName": "text",
        "title": null,
        "price": null,
        "photoUrl": null,
        "sku": null
      }
    }
  ]
}