`get_org_admin_by_orgid_groups`

Read-only

Calls GET /api/org-admin/{orgId}/groups as the signed-in person · REST reference

The organization's groups, their roles and rosters

With the caller's own token; requires admin.groups.view in the organization (every member holds it).

Arguments

Argument	Type		Description
`orgId`path	string (uuid)	required

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_org_admin_by_orgid_groups",
    "arguments": {
      "orgId": "11111111-1111-4111-8111-111111111111"
    }
  }
}

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

The organization's live groups — OWNER, then MEMBER, then its own.

json

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "members": [],
      "name": "string",
      "orgId": "11111111-1111-4111-8111-111111111111",
      "reserved": true,
      "roles": [],
      "description": "string",
      "type": "string"
    }
  ],
  "success": true
}

Fields

Field	Type	Description
`data`	array of object
`data[].description`	string \| null
`data[].id`	string (uuid)
`data[].members`	array of object
`data[].members[].email`	string \| null
`data[].members[].firstName`	string \| null
`data[].members[].lastName`	string \| null
`data[].members[].status`	"INVITED" \| "REQUESTED" \| "ACCEPTED" \| "APPROVED" \| "ACTIVE" \| "DECLINED" \| … (8 values)	Only ACTIVE and APPROVED confer anything; INVITED (the org asked) and REQUESTED (the person asked) are pending.
`data[].members[].userId`	string (uuid)
`data[].name`	string
`data[].orgId`	string (uuid)
`data[].reserved`	boolean	The organization's OWNER and MEMBER groups — never renamed, deleted or given other roles, and the OWNER group's one member changes only by an ownership transfer.
`data[].roles`	array of object
`data[].roles[].code`	string \| null
`data[].roles[].editable`	boolean	One of this organization's own, non-built-in roles — settable on a group.
`data[].roles[].id`	string (uuid)
`data[].roles[].name`	string
`data[].type`	string \| null
`success`	true

When it fails

A failed call returns isError: true with the API's message as text.

400: The request was malformed or failed a guard.
403: Authenticated, but the caller holds none of the required permissions.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json

{
  "name": "get_org_admin_by_orgid_groups",
  "description": "GET /api/org-admin/{orgId}/groups — With the caller's own token; requires `admin.groups.view` in the organization (every member holds it).",
  "inputSchema": {
    "type": "object",
    "properties": {
      "orgId": {
        "type": "string"
      }
    },
    "required": [
      "orgId"
    ]
  },
  "annotations": {
    "readOnlyHint": true,
    "openWorldHint": false
  }
}