Interactions

List Interactions

Changed on

Returns paginated verified earn interactions (deposits and withdrawals), ordered by date descending by default. Optionally filter by interactionType, distributorId, opportunityId and/or productId.

get/v2/interactions/

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

pageinteger
limitinteger
pageLimitinteger
pageSizeinteger
interactionType'deposit' | 'withdraw'

Filter by interaction type: 'deposit' or 'withdraw' (absent returns both)

distributorIdstring

Optional distributor ID to scope interactions

opportunityIdstring

Optional opportunity UUID to scope interactions

productIdstring

Optional product UUID to scope interactions to opportunities belonging to that product

sortBystring

One of: date, usdValue, amount, opportunity, distributor, wallet, type (defaults to date)

sortOrderstring

asc or desc (defaults to desc)

Response

OK

Example response

{
  "data": [
    {
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "opportunityId": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  ]
}

Changes

  • v260527ba59276Revision changes
    • info

      added the new optional query request parameter pageLimit

    • info

      added the new optional query request parameter pageSize

    • info

      added the optional property / to the response with the status

  • v2e6d1393d9ae8Revision changes
    • info

      endpoint added