Users

Get User's inventory items

Retrieve a complete list of items in the User's inventory with filtering options. This includes: - All purchased products - Subscription items - Limited-time access items Use filters to narrow down results by product type.

Authorization

Public key
x-fngs-public-key<token>

In: header

Path Parameters

userId*string

Unique identifier of the User to archive.

Formatuuid

Query Parameters

page?integer

Page number for pagination (1-based).

Formatint64
Range1 < value <= 9007199254740991
Default1
limit?integer

Number of items per page.

Formatint64
Range1 < value <= 100
Default10
productType?string

Filter inventory by product type.

Value in

  • "DigitalDownload"
  • "Game"
  • "GiftCard"
  • "SoftwareKey"
  • "VirtualCurrency"
  • "VirtualItem"
  • "Subscription"
  • "OneTimePayment"

Response Body

application/json

application/json

GET
/v0/users/{userId}/inventory
curl -X GET "https://example.com/v0/users/123e4567-e89b-12d3-a456-426614174000/inventory"
{  "status": "success",  "data": {    "inventory": [      {        "object": "item",        "quantity": 0,        "value": 0,        "currency": "AFN",        "name": "string",        "variant": null,        "plan": null,        "product": {          "object": "product",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "type": "DigitalDownload",          "internalId": null        },        "offer": {          "object": "offer",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "internalId": null        },        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "customFields": null      }    ],    "count": -1.7976931348623157e+308,    "pages": -1.7976931348623157e+308  }}

Unarchive User PATCH

Restore a User account that has been previously archived.

List webhooks GET

Retrieve all configured webhooks for the workspace, newest first. A workspace may have at most a small, fixed number of webhooks configured at once — see the create endpoint's error if that limit is reached.