Skip to content
adversarial

Returns per-role member counts and a bounded sample of member avatars.

GET
/v1/organizations/roles/members-summary
curl --request GET \
  --url https://api.adversarial.com/api/v1/organizations/roles/members-summary

Responses

Section titled “Responses”

200

Section titled “200”

Per-role member counts and sample avatars

Media typeapplication/json
object
sample_limit
required

Maximum length of any sample_members list in this response.

integer format: int32
summaries
required
Array<object>
object
member_count
required

Number of active members holding this role.

integer format: int32
role_id
required
string format: uuid
role_name
required
string
sample_members
required

Sample of members for avatar tiles.

Array<object>

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object
email
required
string
first_name
required
string
icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null
id
required
string format: uuid
last_name
required
string
Examplegenerated
{
  "sample_limit": 1,
  "summaries": [
    {
      "member_count": 1,
      "role_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "role_name": "example",
      "sample_members": [
        {
          "email": "example",
          "first_name": "example",
          "icon": "example",
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "last_name": "example"
        }
      ]
    }
  ]
}