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

# get

# OpenAPI definition

```json
{
  "info": {
    "title": "accounts basic",
    "version": "1.0",
    "contact": {
      "name": "Beamable Support",
      "url": "https://api.beamable.com",
      "email": "support@beamable.com"
    }
  },
  "servers": [
    {
      "url": "https://api.beamable.com"
    }
  ],
  "paths": {
    "/basic/accounts/search": {
      "get": {
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountSearchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        },
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          },
          {
            "name": "pagesize",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "security": [
          {
            "scope": [],
            "user": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ThirdPartyAssociation": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "userBusinessId": {
            "type": "string"
          },
          "userAppId": {
            "type": "string"
          },
          "meta": {
            "type": "object",
            "additionalProperties": {}
          },
          "appId": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "appId",
          "userAppId",
          "meta"
        ]
      },
      "InFlightMessage": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "method": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "gamerTag": {
            "type": "integer",
            "format": "int64"
          },
          "shard": {
            "type": "string"
          },
          "service": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "service",
          "id",
          "method",
          "path",
          "body"
        ]
      },
      "RoleMapping": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "projectId": {
            "type": "string"
          },
          "role": {
            "type": "string"
          }
        },
        "required": [
          "projectId",
          "role"
        ]
      },
      "GamerTagAssociation": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "projectId": {
            "type": "string"
          },
          "gamerTag": {
            "type": "integer",
            "format": "int64"
          }
        },
        "required": [
          "projectId",
          "gamerTag"
        ]
      },
      "AccountSearchResponse": {
        "properties": {
          "accounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Account"
            }
          }
        },
        "additionalProperties": false,
        "title": "Account Search Response",
        "type": "object",
        "required": [
          "accounts"
        ]
      },
      "Account": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "inFlight": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InFlightMessage"
            }
          },
          "createdTimeMillis": {
            "type": "integer",
            "format": "int64"
          },
          "realmId": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "roleString": {
            "type": "string"
          },
          "deviceIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "privilegedAccount": {
            "type": "boolean"
          },
          "country": {
            "type": "string"
          },
          "wasMigrated": {
            "type": "boolean"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "gamerTags": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GamerTagAssociation"
            }
          },
          "language": {
            "type": "string"
          },
          "roles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RoleMapping"
            }
          },
          "updatedTimeMillis": {
            "type": "integer",
            "format": "int64"
          },
          "thirdParties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ThirdPartyAssociation"
            }
          },
          "deviceId": {
            "type": "string"
          },
          "userName": {
            "type": "string"
          },
          "heartbeat": {
            "type": "integer",
            "format": "int64"
          },
          "password": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "gamerTags",
          "thirdParties",
          "createdTimeMillis",
          "updatedTimeMillis",
          "privilegedAccount"
        ]
      }
    },
    "securitySchemes": {
      "scope": {
        "type": "apiKey",
        "name": "X-DE-SCOPE",
        "in": "header",
        "description": "Customer and project scope. This should contain the '<customer-id>.<project-id>'."
      },
      "user": {
        "type": "http",
        "description": "Bearer authentication with an player access token in the Authorization header.",
        "scheme": "bearer",
        "bearerFormat": "Bearer <Access Token>"
      }
    }
  },
  "security": [],
  "externalDocs": {
    "description": "Beamable Documentation",
    "url": "https://docs.beamable.com"
  },
  "openapi": "3.0.2",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```