4 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GET /v2/groups/{groupId}/roles/{roleId}/invitations — openapi

List open invitations to a group that grant a role

Endpoint

Method: GET

Path: /v2/groups/{groupId}/roles/{roleId}/invitations

Servers:

• https://groups.roblox.com

Parameters

[
  {
    "name": "groupId",
    "in": "path",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "roleId",
    "in": "path",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "Cursor",
    "in": "query",
    "description": "Cursor returned by a previous page. Omit for the first page.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "Limit",
    "in": "query",
    "description": "Page size: 10, 25, 50, or 100. Defaults to 10.",
    "schema": {
      "type": "integer",
      "format": "int32"
    }
  },
  {
    "name": "SortOrder",
    "in": "query",
    "description": "Sort order. Only `Asc` is currently supported; defaults to `Asc`.",
    "schema": {
      "$ref": "#/components/schemas/OrganizationsServiceApi.SortOrder"
    }
  }
]

Responses

{
  "200": {
    "description": "Success",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/GroupInvitationCursorPageResponse"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
        }
      }
    }
  },
  "401": {
    "description": "Unauthorized",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
        }
      }
    }
  },
  "403": {
    "description": "Forbidden",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
        }
      }
    }
  },
  "404": {
    "description": "Not Found",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
        }
      }
    }
  },
  "500": {
    "description": "Server Error",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Related Schemas

• OrganizationsServiceApi.SortOrder

• GroupInvitationCursorPageResponse

• OrganizationsServiceApi.ErrorResponse

Complete Operation Definition

{
  "summary": "List open invitations to a group that grant a role",
  "parameters": [
    {
      "name": "groupId",
      "in": "path",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "roleId",
      "in": "path",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "Cursor",
      "in": "query",
      "description": "Cursor returned by a previous page. Omit for the first page.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "Limit",
      "in": "query",
      "description": "Page size: 10, 25, 50, or 100. Defaults to 10.",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "SortOrder",
      "in": "query",
      "description": "Sort order. Only `Asc` is currently supported; defaults to `Asc`.",
      "schema": {
        "$ref": "#/components/schemas/OrganizationsServiceApi.SortOrder"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GroupInvitationCursorPageResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
          }
        }
      }
    },
    "404": {
      "description": "Not Found",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
          }
        }
      }
    },
    "500": {
      "description": "Server Error",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationsServiceApi.ErrorResponse"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://groups.roblox.com"
    }
  ],
  "x-roblox-stability": "BETA",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ]
}