Progress

Get progress of user in collection-challenges

PreviousInventory NextError Handling

Last updated 1 month ago

Was this helpful?

Get Overall Collections Progress

get

Retrieves the user's progress across all collections

Authorizations

Path parameters

platformstringrequired

The platform identifier (e.g., "discord", "roblox")

Example: discord

platformUserIdstringrequired

The user's ID on the specified platform

Example: 123456789012345678

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.giftoin.org/api/v1/users/{platform}/{platformUserId}/progress/collection-challenges' \
  --header 'x-gft_api_key: YOUR_API_KEY'

200

400

401

[
  {
    "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
      }
    }
  }
]

Successful operation

Get One Collection Progress

get

Retrieves the user's progress for a specific collection