---
updatedAt: 2025-11-11T02:12:45.000Z
agentTools:
  projectIndex: https://beamable2.readme.io/llms.txt
---

# get

# OpenAPI definition

```json
{
  "info": {
    "title": "group-users object",
    "version": "1.0",
    "contact": {
      "name": "Beamable Support",
      "url": "https://api.beamable.com",
      "email": "support@beamable.com"
    }
  },
  "servers": [
    {
      "url": "https://api.beamable.com"
    }
  ],
  "paths": {
    "/object/group-users/{objectId}/recommended": {
      "get": {
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupSearchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        },
        "parameters": [
          {
            "name": "objectId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "security": [
          {
            "scope": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "DonationEntry": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "playerId": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "time": {
            "type": "integer"
          }
        },
        "required": [
          "playerId",
          "amount",
          "time"
        ]
      },
      "Member": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "canDemote": {
            "type": "boolean"
          },
          "canKick": {
            "type": "boolean"
          },
          "role": {
            "type": "string"
          },
          "gamerTag": {
            "type": "integer"
          },
          "canPromote": {
            "type": "boolean"
          },
          "scores": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupScoreBinding"
            }
          }
        },
        "required": [
          "gamerTag"
        ]
      },
      "InFlightMessage": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "method": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "gamerTag": {
            "type": "integer"
          },
          "shard": {
            "type": "string"
          },
          "service": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        }
      },
      "GroupRole": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "permissions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "DonationRequest": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "timeRequested": {
            "type": "integer"
          },
          "progress": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DonationEntry"
            }
          },
          "satisfied": {
            "type": "boolean"
          },
          "playerId": {
            "type": "integer"
          },
          "currency": {
            "$ref": "#/components/schemas/Currency"
          }
        },
        "required": [
          "playerId",
          "timeRequested",
          "satisfied"
        ]
      },
      "GroupSearchResponse": {
        "properties": {
          "groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Group"
            }
          }
        },
        "additionalProperties": false,
        "title": "Group Search Response",
        "type": "object"
      },
      "Group": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "inFlight": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InFlightMessage"
            }
          },
          "name": {
            "type": "string"
          },
          "enrollmentType": {
            "type": "string"
          },
          "donations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DonationRequest"
            }
          },
          "freeSlots": {
            "type": "integer"
          },
          "maybeDonations": {
            "type": "object",
            "additionalProperties": true
          },
          "tag": {
            "type": "string"
          },
          "canUpdateMOTD": {
            "type": "boolean"
          },
          "shard": {
            "type": "string"
          },
          "canUpdateSlogan": {
            "type": "boolean"
          },
          "leader": {
            "type": "integer"
          },
          "slogan": {
            "type": "string"
          },
          "requirement": {
            "type": "integer"
          },
          "motd": {
            "type": "string"
          },
          "version": {
            "type": "integer"
          },
          "id": {
            "type": "integer"
          },
          "clientData": {
            "type": "string"
          },
          "roles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupRole"
            }
          },
          "scores": {
            "type": "object",
            "additionalProperties": true
          },
          "canUpdateEnrollment": {
            "type": "boolean"
          },
          "members": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Member"
            }
          },
          "canDisband": {
            "type": "boolean"
          },
          "type": {
            "type": "string",
            "enum": [
              "not-available"
            ]
          },
          "maxSize": {
            "type": "integer"
          },
          "subGroups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Group"
            }
          },
          "created": {
            "type": "integer",
            "format": "utc-millisec"
          }
        },
        "required": [
          "id",
          "requirement",
          "maxSize",
          "freeSlots",
          "leader"
        ]
      },
      "Currency": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "amount"
        ]
      },
      "GroupScoreBinding": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "board": {
            "type": "string"
          },
          "derivatives": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "score": {
            "type": "integer"
          }
        },
        "required": [
          "score"
        ]
      }
    },
    "securitySchemes": {
      "scope": {
        "type": "apiKey",
        "name": "X-DE-SCOPE",
        "in": "header",
        "description": "Customer and project scope. This should contain the '<customer-id>.<project-id>'."
      }
    }
  },
  "security": [],
  "externalDocs": {
    "description": "Beamable Documentation",
    "url": "https://docs.beamable.com"
  },
  "openapi": "3.0.2",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```