Get group recognition recipient count

Resolve a Bonusly user group by name, slug, or type and return how many
recipients an actual group post would reach within your company — plus a
paginated roster of those recipients (id and name).

Accepted inputs for group_name:

  • "everyone" → the @everyone group (all active receiving users in the
    company)
  • A department name (e.g. "Engineering")
  • A location name (e.g. "Berlin")
  • A team — the manager's name plus "team" (e.g. "Sarah's team") or the
    team slug

Returns recipient_count plus the resolved group_name / group_type /
group_slug, and a members array of {id, name}. Membership is
paginated: members is one page (size limit, default
50, max
200); when more pages
exist next_cursor is non-null — pass it back as cursor to fetch the
next page. Keep the rest of the input (notably group_name) identical
across pages.

Returns an error if no matching group is found, or if more than one
non-reserved group matches the same name (e.g. a department and a
location both named "Sales").

Required OAuth scope: recognition:read or recognition:administer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Allowed:
string
enum
required
Allowed:
params
object
required
string
required
Responses

401

Unauthorized

403

Forbidden

Language
Credentials
Bearer
OAuth2 access token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json