groups

Get group transactions

Retrieves unified expenses and transfers for a group

get/groups/{id}/transactions

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/groups/{id}/transactions
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Group UUID

Query parameters

sortOrder'ASC' | 'DESC'

Sort order (default: DESC)

sortBy'createdAt' | 'amount' | 'description' | 'transactionDate'

Sort field (default: createdAt)

settlements'exclude' | 'only'

Hide settlement transfers (exclude) or return only them (only)

recipientIdsstring[]

Filter by recipient user IDs (Pro feature)

payerIdsstring[]

Filter by payer user IDs (Pro feature)

toDatestring

End date filter (ISO string)

fromDatestring

Start date filter (ISO string)

type'expense' | 'transfer'

Filter by transaction type

currencystring

Filter by currency

searchstring

Search term

limitnumber

Items per page (default: 10)

pagenumber

Page number (default: 1)

Response

Group transactions retrieved successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.