Progress
Get progress of user in collection-challenges
Retrieves the user's progress across all collections
Authorizations
Path parameters
platformstringRequiredExample:
The platform identifier (e.g., "discord", "roblox")
discord
platformUserIdstringRequiredExample:
The user's ID on the specified platform
123456789012345678
Responses
200
Successful operation
application/json
400
Bad Request - Missing or invalid parameters
application/json
401
Unauthorized - API key is missing or invalid
application/json
get
GET /api/v1/users/{platform}/{platformUserId}/progress/collection-challenges HTTP/1.1
Host: api.giftoin.org
x-gft_api_key: YOUR_API_KEY
Accept: */*
[
{
"id": "program_123",
"name": "Winter Challenge",
"image": "https://example.com/images/winter-challenge.png",
"description": "Collect all winter-themed cards",
"size": 10,
"cards": [
{
"name": "Snowflake Card",
"id": "card_456",
"image": "https://example.com/images/snowflake.png",
"ownedQuantity": 2,
"isOwned": true,
"rarity": "rare"
}
],
"progressInPercentage": 30,
"environment": "production",
"createdTimestamp": 1644825600000,
"timeLeft": 604800000,
"reward": {
"id": "reward_789",
"name": "Winter Champion Badge",
"image": "https://example.com/images/winter-badge.png",
"description": "Awarded to those who complete the Winter Challenge",
"isClaimed": false,
"canClaim": false,
"value": "text",
"claimedTimestamp": 1,
"viewType": "QR"
},
"status": "in_progress",
"collectedCount": 3,
"duration": {
"start": {
"date": 1644825600000,
"showBefore": true
},
"end": {
"date": 1647417600000,
"showAfter": false
}
}
}
]
Retrieves the user's progress for a specific collection
Authorizations
Path parameters
platformstringRequiredExample:
The platform identifier (e.g., "discord", "roblox")
discord
platformUserIdstringRequiredExample:
The user's ID on the specified platform
123456789012345678
programIdstringRequiredExample:
The unique identifier for the program/collection
program_123
Responses
200
Successful operation
application/json
400
Bad Request - Missing or invalid parameters
application/json
401
Unauthorized - API key is missing or invalid
application/json
get
GET /api/v1/users/{platform}/{platformUserId}/progress/collection-challenges/{programId} HTTP/1.1
Host: api.giftoin.org
x-gft_api_key: YOUR_API_KEY
Accept: */*
{
"id": "program_123",
"name": "Winter Challenge",
"image": "https://example.com/images/winter-challenge.png",
"description": "Collect all winter-themed cards",
"size": 10,
"cards": [
{
"name": "Snowflake Card",
"id": "card_456",
"image": "https://example.com/images/snowflake.png",
"ownedQuantity": 2,
"isOwned": true,
"rarity": "rare"
}
],
"progressInPercentage": 30,
"environment": "production",
"createdTimestamp": 1644825600000,
"timeLeft": 604800000,
"reward": {
"id": "reward_789",
"name": "Winter Champion Badge",
"image": "https://example.com/images/winter-badge.png",
"description": "Awarded to those who complete the Winter Challenge",
"isClaimed": false,
"canClaim": false,
"value": "text",
"claimedTimestamp": 1,
"viewType": "QR"
},
"status": "in_progress",
"collectedCount": 3,
"duration": {
"start": {
"date": 1644825600000,
"showBefore": true
},
"end": {
"date": 1647417600000,
"showAfter": false
}
}
}
Last updated
Was this helpful?