Get api v2 flux Run in API Explorer

GET /api/v2/flux
Personal access token & O auth2
application/json

Body Required

  • model_type string Required

    The model type. Can be: account, plan, or circle.

  • model_uuid string Required

    The model UUID

  • start_date date Required

    Filter them down by choosing the start date. This will return all fluxes between the start and end date.

  • end_date date Required

    Filter them down by choosing the end date.

  • filter object
    Hide filter attribute Show filter attribute object
    • include_inactive boolean

      Include transactions from inactive plans. When true, only transactions that occurred before the plan became inactive are included.

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
GET /api/v2/flux 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/flux' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"model_type":"account","model_uuid":"0b067554-747a-4bca-bdd8-af4a2a62b636","start_date":"2025-11-08","end_date":"2025-11-15","filter":{"include_inactive":false}}'
Request examples 
{
  "model_type": "account",
  "model_uuid": "0b067554-747a-4bca-bdd8-af4a2a62b636",
  "start_date": "2025-11-08",
  "end_date": "2025-11-15",
  "filter": {
    "include_inactive": false
  }
}
Response examples (401) 
{
  "message": "Unauthenticated."
}