Gets a game key list from the specified group for building a catalog.
project_id required | integer Project ID. You can find this parameter in your Publisher Account next to the name of the project. Example: 44056 |
external_id required | string Default: "all" Group external ID. |
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 |
locale | string Default: "en" Response language. Two-letter lowercase language code per ISO 639-1. |
additional_fields[] | Array of strings The list of additional fields. These fields will be in the response if you send them in your request. |
country | string Two-letter uppercase country code per ISO 3166-1 alpha-2. Check the documentation for detailed information about countries supported by Xsolla and the process of determining the country. Example: country=US |
promo_code | string [ 1 .. 128 ] characters Unique case sensitive code. Contains letters and numbers. Example: promo_code=WINTER2021 |
show_inactive_time_limited_items | integer Default: 0 Shows time-limited items that are not available to the user. The validity period of such items has not started or has already expired. Example: show_inactive_time_limited_items=1 |
The list of game keys was successfully received.
{- "has_more": true,
- "items": [
- {
- "sku": "game_1",
- "name": "Game name",
- "groups": [
- {
- "external_id": "all",
- "name": "All games"
}, - {
- "external_id": "Xsolla",
- "name": "Xsolla games"
}
], - "type": "game_key",
- "description": "Game description",
- "attributes": [
- {
- "external_id": "OS",
- "name": "OS",
- "values": [
- {
- "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
- "value": "Windows"
}
]
}, - {
- "external_id": "genre",
- "name": "Genre",
- "values": [
- {
- "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
- "value": "Horror"
}
]
}
], - "is_free": false,
- "price": {
- "amount": "30.5",
- "amount_without_discount": "30.5",
- "currency": "USD"
}, - "virtual_prices": [ ],
- "drm_name": "Steam",
- "drm_sku": "steam",
- "has_keys": true,
- "is_pre_order": true,
- "release_date": "2020-08-11T10:00:00+03:00",
- "periods": [
- {
- "date_from": "2020-08-11T10:00:00+03:00",
- "date_until": "2020-08-11T20:00:00+03:00"
}
]
}, - {
- "sku": "game_2",
- "name": "Game name",
- "groups": [
- {
- "external_id": "all",
- "name": "All games"
}
], - "type": "game_key",
- "description": "Game description",
- "attributes": [
- {
- "external_id": "OS",
- "name": "OS",
- "values": [
- {
- "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
- "value": "Windows"
}
]
}, - {
- "external_id": "genre",
- "name": "Genre",
- "values": [
- {
- "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
- "value": "Horror"
}
]
}
], - "is_free": false,
- "price": {
- "amount": "30.5",
- "amount_without_discount": "30.5",
- "currency": "USD"
}, - "virtual_prices": [ ],
- "drm_name": "Steam",
- "drm_sku": "steam",
- "has_keys": true,
- "is_pre_order": false,
- "release_date": null,
- "periods": [ ]
}
]
}