Cloud APIs
InventoryApi
inventoryItemsForUser

inventoryItemsForUser

Parameters

NameTypeDescription
userIdIdentifierThe id of the user to get the inventory items for.
limit?numberThe maximum amount of items to return.
filter?UnionPrettify<InventoryItemsForUser_Filter>Filters the returned inventory items by specified criterias.
cursor?stringA paging cursor for a specified page.

Example

const { data: inventoryItems } = await InventoryApi.inventoryItemsForUser({
  userId: 45348281,
  limit: 3,
  filter: { privateServers: true },
}); 

Example Data

{
  inventoryItems: [
    {
      path: "users/45348281/inventory-items/R0FNRV9QQVNTX0lEPTEyNTI3",
      gamePassDetails: { gamePassId: "12527" },
    },
  ],
  nextPageToken: "djEveyJGaWVsZEluZGV4IjoyLCJWYWx1ZUluZGV4IjowLCJDdXJzb3IiOiIxMjUyNyIsIkZpbHRlckhhc2giOiJrV3Y2VFQ0ZW1FOGgzT1RQL1hjOXFkdGIwR0JiWjNySkRMU3FTSmV5TUVJPSJ9",
} 

Endpoint

GET /v2/users/{userId}/inventory-items