Skip to main content
GET
/
v0
/
users
/
{userId}
/
inventory
Get User's inventory items
curl --request GET \
  --url https://api.fungies.io/v0/users/{userId}/inventory \
  --header 'x-fngs-public-key: <api-key>'
{
  "status": "<string>",
  "data": {
    "inventory": [
      {
        "name": "<string>",
        "product": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "object": "product",
          "internalId": null
        },
        "offer": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "object": "offer",
          "internalId": null
        },
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "object": "item",
        "quantity": 0,
        "value": 0,
        "variant": null,
        "plan": null,
        "customFields": null
      }
    ],
    "count": 0,
    "pages": 0
  }
}

Authorizations

​
x-fngs-public-key
string
header
required

Path Parameters

​
userId
string<uuid>
required

Unique identifier of the User to archive.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Query Parameters

​
page
integer<int64>
default:1

Page number for pagination (1-based).

Required range: x <= 9007199254740991
​
limit
integer<int64>
default:10

Number of items per page.

Required range: x <= 100
​
productType
enum<string>

Filter inventory by product type.

Available options:
DigitalDownload,
Game,
GiftCard,
SoftwareKey,
VirtualCurrency,
VirtualItem,
Subscription,
OneTimePayment
Example:

"OneTimePayment"

​
expiresAfter
integer<int64> | null

Filter items expiring after this timestamp. Useful for showing only active or future-valid items. Accepts Unix timestamp in seconds or milliseconds.

Required range: 0 <= x <= 9007199254740991
Example:

1735689599

Response

GET /v0/users/:userId/inventory Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required