Retrieve risk for all groups in a group type

GET /api/v1/group-types/{group_type_identifier}/risk

Path parameters

  • group_type_identifier string Required

    The id or a code for a group type

Query parameters

  • date string

    Optional. The date for the results. In YYYY-MM-DD format. Defaults to latest results date.

Responses

  • 200 application/json

    Risk results for all groups in a group type on a particular date

    Hide response attributes Show response attributes object
    • sample_date string

      The date when the questions were asked

    • group object
      Hide group attributes Show group attributes object
      • id integer

        Group ID

      • code string

        Group code

      • name string

        Group name

    • risks object
      Hide risks attributes Show risks attributes object
      • under_performance string

        Underperformance risk

      • flight string

        Flight risk

      • burnout string

        Burnout risk

    • contributors object
      Hide contributors attributes Show contributors attributes object
      • happiness_kpi string

        Risk contribution from happiness

      • team_cooperation string

        Risk contribution from team cooperation

      • work_life_balance string

        Risk contribution from work life balance

      • appreciation string

        Risk contribution from appreciation

      • feedback string

        Risk contribution from feedback

      • accomplishment string

        Risk contribution from accomplishment

GET /api/v1/group-types/{group_type_identifier}/risk
curl \
 --request GET 'https://app.fridaypulse.com/api/v1/group-types/{group_type_identifier}/risk' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "group": {
      "id": 34,
      "code": "sales-team",
      "name": "Sales Team"
    },
    "risks": {
      "flight": "low_risk",
      "burnout": "no_risk",
      "under_performance": "high_risk"
    },
    "sample_date": "2025-07-24",
    "contributors": {
      "feedback": "no_concern",
      "happiness": "no_concern",
      "appreciation": "low_concern",
      "accomplishment": "high_concern",
      "team-cooperation": "no_concern",
      "work-life-balance": "no_concern"
    }
  }
]