Skip to main content

BiddingRoundCustomerListResponse

data object[]required
  • Array [
  • idstring<uuid>required
    Example: c2daddd4-0809-46dd-b9cd-bef9945e28fe
    namestringrequired
    Example: Round 1
    description objectrequired
    oneOf
    string
    endAt objectrequired

    Bidding deadline configured on the round. Will be null if no deadline is set in a draft round. The deadline is already saved, or the round has been published, this field is guaranteed to be non-null.

    oneOf
    string<date-time>
    statusstringrequired

    Possible values: [draft, published, completed]

    Example: draft
    createdAtstring<date-time>required
    Example: 2023-12-31T12:54:55.671Z
    startAt objectrequired
    oneOf
    string<date-time>
  • ]
  • pagination objectrequired
    nextCursor objectrequired

    A cursor used to fetch the next page of results. It is null if there is no next page. Use the value as cursor parameter to fetch the next page.

    oneOf
    string
    hasMorebooleanrequired

    Indicates whether there are more results available. Keep calling the API with the provided nextCursor until hasMore is false to retrieve all results.

    totalnumberrequired

    The total number of results available.

    Example: 42
    BiddingRoundCustomerListResponse
    {
    "data": [
    {
    "id": "d1247eac-0b4d-42ef-8f74-87b5decfd368",
    "name": "Round 1",
    "description": null,
    "endAt": "2023-12-31T23:44:44.312Z",
    "status": "draft",
    "createdAt": "2023-12-31T03:34:15.465Z",
    "startAt": "2023-12-31T15:05:15.255Z"
    }
    ],
    "pagination": {
    "nextCursor": "MjAyNS0wMS0wMSAxNzoyOTo1OS4yNwo=",
    "hasMore": true,
    "total": 42
    }
    }