Giftoin Docs
  • 👋INTRODUCTION
    • Welcome to Giftoin
    • Overview
    • Quick Start
    • FAQs
    • Key Features
  • 🧩API REFERENCE
    • Standards and Conventions
    • Orders API
      • Tokens/Points
      • Collectibles/Cards
      • Collectibles/Random Cards
    • Users API
      • Inventory
      • Progress
    • Error Handling
  • 💻PLATFORM GUIDES
    • Roblox
      • Why use Giftoin?
      • Basic Usage
      • Developer Access
      • Installation
      • Additional Example / Use-Cases
        • Point Reward
        • Daily Reward
        • Advanced Point Distribution System
        • Managed Codes & In-Game Rewards (Coming Soon)
          • Registering Reward Types
      • Tools and Scripts
        • Rotating Script
        • Floating Script
        • Quest System (Coming Soon)
    • Discord
      • Introduction
      • Getting Started
      • Command Reference
      • Role System
      • User Guides
      • Troubleshooting
      • FAQs
    • Wordpress
  • 📚Resources
    • Use Cases
      • Basic
      • eCommerce
      • Games
    • Support
Powered by GitBook
On this page

Was this helpful?

  1. API REFERENCE
  2. Users API

Inventory

PreviousUsers APINextProgress

Last updated 2 months ago

Was this helpful?

🧩

Get User Inventory

get

Retrieves a user's inventory, including collections and points

Authorizations
Path parameters
platformstringRequired

The platform identifier (e.g., "discord", "roblox")

Example: discord
platformUserIdstringRequired

The user's ID on the specified platform

Example: 123456789012345678
Responses
200
Successful operation
application/json
400
Bad Request - Missing or invalid parameters
application/json
401
Unauthorized - API key is missing or invalid
application/json
get
GET /api/v1/users/{platform}/{platformUserId}/inventory HTTP/1.1
Host: api.giftoin.org
x-gft_api_key: YOUR_API_KEY
Accept: */*
{
  "collections": [
    {
      "id": "collection_123",
      "name": "Winter Collection",
      "description": "Limited edition winter cards",
      "cards": [
        {
          "id": "card_456",
          "name": "Snowflake Card",
          "image": "https://example.com/images/snowflake.png",
          "quantity": 2,
          "rarity": "rare"
        }
      ]
    }
  ],
  "points": [
    {
      "name": "Gold Points",
      "id": "point_789",
      "image": "https://example.com/images/gold-point.png",
      "quantity": 150
    }
  ]
}