Get list of games owned by user

Xsolla Developers

Get list of games owned by userClient-side

get/v2/project/{project_id}/entitlement

Get the list of games owned by the user. The response will contain an array of games owned by a particular user.

Attention

All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0
sandbox	integer Default: 0 What type of entitlements should be returned. If the parameter is set to 1, the entitlements received by the user in the sandbox mode only are returned. If the parameter isn't passed or is set to 0, the entitlements received by the user in the live mode only are returned.
additional_fields[]	Array of strings The list of additional fields. These fields will be in the response if you send them in your request. Available fields `attributes`.

Responses

200

Successfully received a list of game keys owned by the user.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

Request samples

curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/{project_id}/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"has_more": false,
"total_items_count": 1,
"items": [{"name": "The Greatest Game in the World",
"description": "Description of the greatest game in the world.",
"image_url": "https://none",
"project_id": 30810,
"game_sku": "com.xsolla.key_1",
"drm": "drmfree",
"is_pre_order": false
}
]
}