Retrieve group information

GET /api/v1/groups/{group_identifier}

Path parameters

  • group_identifier string Required

    The id or a code for a group

Responses

  • 200 application/json

    Group information

    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/groups/{group_identifier}
curl \
 --request GET 'https://app.fridaypulse.com/api/v1/groups/{group_identifier}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "id": 1,
  "code": "group-code",
  "name": "Group name",
  "parent_id": 2
}