3 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 /v1/users/search — openapi

Searches for users by keyword.

Endpoint

Method: GET

Path: /v1/users/search

Servers:

• https://users.roblox.com

Parameters

[
  {
    "in": "query",
    "name": "keyword",
    "description": "The search keyword.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "sessionId",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "limit",
    "description": "The number of results per request.",
    "schema": {
      "type": "integer",
      "format": "int32",
      "enum": [
        10,
        25,
        50,
        100
      ],
      "default": 10
    }
  },
  {
    "in": "query",
    "name": "cursor",
    "description": "The paging cursor for the previous or next page.",
    "schema": {
      "type": "string"
    }
  }
]

Responses

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Users.Api.SearchGetUserResponse_"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Users.Api.SearchGetUserResponse_"
        }
      }
    }
  },
  "400": {
    "description": "5: The keyword was filtered.\r\n6: The keyword is too short."
  },
  "429": {
    "description": "4: Too many requests."
  }
}

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

• Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Users.Api.SearchGetUserResponse_

Complete Operation Definition

{
  "tags": [
    "Users"
  ],
  "summary": "Searches for users by keyword.",
  "parameters": [
    {
      "in": "query",
      "name": "keyword",
      "description": "The search keyword.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "sessionId",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "limit",
      "description": "The number of results per request.",
      "schema": {
        "type": "integer",
        "format": "int32",
        "enum": [
          10,
          25,
          50,
          100
        ],
        "default": 10
      }
    },
    {
      "in": "query",
      "name": "cursor",
      "description": "The paging cursor for the previous or next page.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Users.Api.SearchGetUserResponse_"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Users.Api.SearchGetUserResponse_"
          }
        }
      }
    },
    "400": {
      "description": "5: The keyword was filtered.\r\n6: The keyword is too short."
    },
    "429": {
      "description": "4: Too many requests."
    }
  },
  "servers": [
    {
      "url": "https://users.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/users#users_get_v1_users_search"
  }
}