GET

/v0/user-id/gamertag/{GAMERTAG}

GAMERTAG*
curl --request GET \
  --url https://api.zebedee.io/v0/user-id/gamertag/{GAMERTAG} \
  --header 'apikey: <apikey>'

ZBD API is migrating the terminology from ZBD Gamertags to ZBD Usernames. There are no breaking changes to you as a developer.

In general, if you used to search for ‘Gamertag’ inside zbd.dev documentation, now search for ‘Username’. Please do also note some ZBD API endpoints are still using gamertag in the URL.

Description

Make use of this endpoint to get a given User’s ID when provided with a ZBD Username.

Usage

This is needed because ZBD Usernames are akin to social media handles, they are swappable. In the scenario where a Developer is using a ZBD Gamertag as the identifier for transaction limits and/or thresholds (for example), a user could simply change their ZBD Gamertag and try to bypass those constraints. Using a truly unique and immutable ID like the User ID will provide Developers with the needed assurances.

Configuration

Path Parameters

GAMERTAGrequired
string

ZBD Username

Header Parameters

apikeyrequired
string

ZBD Project API Key

{
  "success": true,
  "data": {
    "id": "0a59bf56-daa3-4888-8330-cbc02eba3a6e"
  }
}