Groups

List group balance transactions

Changed on

Return paginated balance transactions for a group. The authenticated user must be allowed to view the group. Use search or userId to filter the transaction history.

get/api/v1/groups/transactions/{id}/

Request

  • Base URL
    https://plagiarismcheck.org
  • Auth
    API key in header X-API-TOKEN

Path parameters

idinteger required

Numeric group ID.

Query parameters

searchstring

Optional text search filter. Matching fields depend on the endpoint, for example filename, member name, email, or transaction text.

userIdinteger

Filter by user ID.

pageinteger

Page number for paginated endpoints. Defaults to 1 when omitted.

sizeinteger

Number of records per page. Defaults to 30 when omitted.

Response

The request succeeded and returned paginated group balance transactions.

successboolean

Example response

{
  "success": true,
  "data": {
    "transactions": [
      {
        "id": 3132945,
        "type": 1,
        "created_at": 1512638171000,
        "text_id": 17747739,
        "user": {
          "id": 3132945,
          "name": "John Doe",
          "email": "student@example.com",
          "created_at": 1512638171000,
          "updated_at": 1512638171000,
          "allowed_languages": [
            "en"
          ],
          "balance_type": 1,
          "avatar": "https://randomuser.me/api/portraits/lego/1.jpg",
          "is_email_verification_needed": true
        }
      }
    ]
  },
  "pagination": {
    "last": 3,
    "current": 1,
    "num_items_per_page": 30,
    "first": 1,
    "page_count": 3,
    "total_count": 67,
    "page_range": 3,
    "start_page": 1,
    "end_page": 3,
    "pages_in_range": [
      1,
      2,
      3
    ],
    "first_page_in_range": 1,
    "lastPage_in_range": 3,
    "current_item_count": 30,
    "first_item_number": 1,
    "last_item_number": 30
  }
}

Changes

    • info

      added the optional property / to the response with the status

    • breaking

      the //// response's property format changed from email to no format for status

    • info

      added the optional property //// to the response with the status