Overview

This guide demonstrates how to use the v2/playfull-users/lookup endpoint to map your game's internal user IDs to Playfull user IDs. This is useful for associating in-game users with their Playfull accounts for analytics, rewards, and account management.

Example Request

Send a POST request to the v2/playfull-users/lookup endpoint with your game's ID and an array of internal user IDs.

• [CLIENT_ID]: Unique identifier for the client application, provided by Playfull
• [GAME_ID]: Unique identifier for the game, provided by Playfull
• [GENERATED_SIGNATURE]: A signature that verifies the integrity of the request (see Signature Generation)

POST /v2/playfull-users/lookup
x-client-id: "[CLIENT_ID]"
x-timestamp: "1698306156387"
x-signature: "[GENERATED_SIGNATURE]"
Content-Type: "application/json"
 
{
  "gameId": "[GAME_ID]",
  "userIds": [
    "[USER_ID_1]",
    "[USER_ID_2]",
    "[USER_ID_3]"
  ]
}

Example Response

A successful response returns a mapping of your internal user IDs to Playfull user IDs. If a user does not have an associated Playfull account, the value will be null.

{
  "message": "OK",
  "statusCode": 200,
  "playfullUserIds": {
    "[USER_ID_1]": "[PLAYFULL_USER_ID_1]",
    "[USER_ID_2]": "[PLAYFULL_USER_ID_2]",
    "[USER_ID_3]": null
  }
}

• playfullUserIds: A JSON object where each key is your game's internal user ID and the value is the corresponding Playfull user ID (UUID) or null if not found.