Retrieve list of groups for the group type

GET /api/v1/group-types/{group_type_code}/groups
Bearer auth

Path parameters

  • group_type_code string Required

    The code for the group type

Responses

  • 200 application/json

    List of groups for the group type

    Hide response attributes Show response attributes object
    • id integer

      The group ID

    • code string

      The group code

    • name string

      The group name

    • parent_id integer

      The ID of the group's parent. Only for hierarchical groups.
GET /api/v1/group-types/{group_type_code}/groups 
curl \
 --request GET 'https://app.fridaypulse.com/api/v1/group-types/{group_type_code}/groups' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": 101,
    "code": "female",
    "name": "Female"
  },
  {
    "id": 102,
    "code": "male",
    "name": "Male"
  },
  {
    "id": 103,
    "code": "non-binary",
    "name": "Non-binary"
  }
]