Files
GeyserWebsite/docs/api/global/global-api-web-api-xbox-controller-get-xuid-v-2.api.mdx
T
2024-03-12 00:35:02 -07:00

299 lines
9.8 KiB
Plaintext

---
id: global-api-web-api-xbox-controller-get-xuid-v-2
title: "Get the xuid from a gamertag"
description: "Get the xuid from a gamertag"
sidebar_label: "Get the xuid from a gamertag"
hide_title: true
hide_table_of_contents: true
api: eJzlVd+L40YM/leEnnbBJNnsD65+S8uxHPShHFd6sIRjMlbsuR3PzGnkbELw/17kONlss9CDPvbJtkaS9X2SvtmjNd6vjH3OWO77AmMiNuJi+FRhiY8+roxfJPcXrSaL5CZfV3H7WwzC0XviSU3ybdu56ttmjgUmw6YlIc5YPu2xomzZJU2GJX5pCGrTEoupIa5BGoJfqeJonyF5syPGAp16JiMNFhhMS1jiMQYLZPrROaYKS+GOCsy2odZguUfZJfXNwi7U2PdLdc4phkyKC+ezmT5sDEJB9NWk5J0dkE6/Z61wf5bvbemPJKAoYc2xfQXBlDsvb+p6QvXDZYGJlUlxh/8P1ou8SslwUiBtTZs8YTm/v72/u53f/PIwu/vw4fa+wHXk1giW6II83GFxBOuCUE2MfV+gONFg1PZ87Vz1+Vja6BtX38kK9ur7fg1gco7WGaEKXpw0Q39e+8VgAlCbZAeHXOCGFjKBy2CsjV2Qs0C3oXAKx77Au//YgUDsLBy40AckJpEdtJ1tgDbEOyDmyP9oR0s5m5ouO3I8eLcpQyY4uhQX4/VK+Mfxnz/F84lOl8GFjfGugquRVAYfQ00M0pgANw9gG8P5Wqm7n93+76nTwijrcJ5mzWQIUcAa26g5VPBC8KITqWaz8gQSQeVtGEldDfjdbQgWf3yCKzZC4F3rNOd0CMkkXbo+1GjqPGzzKm6VgEs9kOPeDJpg4EymWpImqnrWJIMqSoMlTjfzqaabatR0f/TvscBMvDmKZsceS2xEUi6nU5PcpKZdJm7tJLJm3xh2Cm7QaxW6TLZjJzssn5aqoOs4KOLI8kHBYZGcxhLnA4SbyWwy1+FKMUtrhgkaBfdf0L2h4qS8QluZJm9c0KQDiP2I/AmHy2GgssBR78pTxmWBTcyifvv9ymT6k33fq/lHRzyiOoI+3Csu63uF5dr4TBclnRYFrz6P83wNP3X9vAtmNJqwG9j3nX5hgc+0O7+e+mVfYEOmIh6qPBwvrKUkZ4EXq6stPE3M48cv2Pd/Az1Anao=
sidebar_class_name: "get api-method"
info_path: api/global/global-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Get the xuid from a gamertag
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/xbox/xuid/{gamertag}"}
>
</MethodEndpoint>
Get the xuid from a gamertag
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"description":"The gamertag of the Bedrock player","in":"path","name":"gamertag","required":true,"schema":{"type":"string"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
The xuid associated with the gamertag or an empty object if there is account with the given gamertag
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"xuid"}
required={true}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"description":"The xuid","example":2535432196048835,"format":"int64","type":"integer"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"xuid\": 2535432196048835\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
The gamertag is invalid (empty or longer than 16 chars)
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"message"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"description":"The error message","type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"message\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"503"}
value={"503"}
>
<div>
The requested account was not cached and we were not able to call the Xbox Live API (rate limited / not setup)
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"message"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"description":"The error message","type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"message\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>