GET /cloud/v2/groups/{group_id}/forum-categories — cloud.docs

List Group Forum Categories

Lists forum categories in the group. Supports filtering.

Endpoint

Method: GET

Path: /cloud/v2/groups/{group_id}/forum-categories

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
group_id	path	true	The group ID.
maxPageSize	query	false	The maximum number of group forum categories to return. The service might return fewer than this value. If unspecified, at most 10 group forum categories are returned. The maximum value is 10 and higher values are set to 10.
pageToken	query	false	A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.
filter	query	false	This field may be set in order to filter the resources returned. Filtering conforms to Common Expression Language (CEL). Only the boolean field `archived` and `==` operator are supported. If `archived=false`, archived categories are not returned. The default value is `false`. Example: `"filter=archived==true"`

[
  {
    "name": "group_id",
    "in": "path",
    "description": "The group ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "maxPageSize",
    "in": "query",
    "description": "The maximum number of group forum categories to return. The service might\nreturn fewer than this value. If unspecified, at most 10 group forum\ncategories are returned. The maximum value is 10 and higher values are set\nto 10.",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "examples": {
      "maxPageSize": {
        "description": "An integer between 1 and 10, inclusive",
        "value": 10
      }
    }
  },
  {
    "name": "pageToken",
    "in": "query",
    "description": "A page token, received from a previous call, to retrieve a subsequent page.\n\nWhen paginating, all other parameters provided to the subsequent call must\nmatch the call that provided the page token.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "filter",
    "in": "query",
    "description": "This field may be set in order to filter the resources returned.\n\nFiltering conforms to Common Expression Language (CEL). Only the boolean\nfield `archived` and `==` operator are supported. If `archived=false`,\narchived categories are not returned. The default value is `false`.\nExample: `\"filter=archived==true\"`",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ListGroupForumCategoriesResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "List Group Forum Categories",
  "description": "Lists forum categories in the group. Supports filtering.",
  "operationId": "Cloud_ListGroupForumCategories",
  "parameters": [
    {
      "name": "group_id",
      "in": "path",
      "description": "The group ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "maxPageSize",
      "in": "query",
      "description": "The maximum number of group forum categories to return. The service might\nreturn fewer than this value. If unspecified, at most 10 group forum\ncategories are returned. The maximum value is 10 and higher values are set\nto 10.",
      "schema": {
        "type": "integer",
        "format": "int32"
      },
      "examples": {
        "maxPageSize": {
          "description": "An integer between 1 and 10, inclusive",
          "value": 10
        }
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "A page token, received from a previous call, to retrieve a subsequent page.\n\nWhen paginating, all other parameters provided to the subsequent call must\nmatch the call that provided the page token.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "This field may be set in order to filter the resources returned.\n\nFiltering conforms to Common Expression Language (CEL). Only the boolean\nfield `archived` and `==` operator are supported. If `archived=false`,\narchived categories are not returned. The default value is `false`.\nExample: `\"filter=archived==true\"`",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListGroupForumCategoriesResponse"
          }
        }
      }
    }
  },
  "x-visibility": "BETA",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "x-roblox-scopes": [
    {
      "name": "group-forum:read"
    }
  ],
  "x-roblox-docs": {
    "category": "Users and groups",
    "methodProperties": {
      "scopes": [
        "group-forum:read"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/GroupForumCategory",
      "name": "GroupForumCategory"
    }
  }
}

GET /cloud/v2/groups/{group_id}/forum-categories — cloud.docs

Endpoint

Parameters

Responses

Authentication

Related Schemas

Complete Operation Definition