Progress

Get progress of user in collection-challenges

Get Overall Collections Progress

get

Retrieves the user's progress across all collections

Authorizations

ApiKeyAuth

x-gft_api_keystringRequired

API key for authentication (can also use x-gft-api-key or gft-api-key)

Path parameters

platformstringRequired

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

Example: discord

platformUserIdstringRequired

The user's ID on the specified platform

Example: 123456789012345678

Responses

200

Successful operation

application/json

Represents a collection challenge or program that users can progress through

idstringOptional

Unique identifier for the program

Example: program_123

namestringOptional

Display name of the program

Example: Winter Challenge

imagestring · uriOptional

URL to the program's image (HTTPS format)

Example: https://example.com/images/winter-challenge.png

descriptionstringOptional

Detailed description of the program's theme and objectives

Example: Collect all winter-themed cards

sizeintegerOptional

Total number of cards in this collection/program

Example: 10

progressInPercentageintegerOptional

User's completion percentage for this collection (0-100)

Example: 30

environmentstringOptional

Environment identifier where this program is active

Example: production

createdTimestampintegerOptional

Timestamp (in milliseconds) when the program was created

Example: 1644825600000

timeLeftintegerOptional

Time remaining in milliseconds until the program ends (not applicable if duration.end is null)

Example: 604800000

statusstring · enumOptional

Current status of the program

Example: in_progressPossible values:

collectedCountintegerOptional

Number of cards the user has collected from this program

Example: 3

400

Bad Request - Missing or invalid parameters

application/json

401

Unauthorized - API key is missing or invalid

application/json

get

/users/{platform}/{platformUserId}/progress/collection-challenges

HTTPcURLJavaScriptPython

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
      }
    }
  }
]

Get One Collection Progress

get

Retrieves the user's progress for a specific collection

Authorizations

ApiKeyAuth

x-gft_api_keystringRequired

API key for authentication (can also use x-gft-api-key or gft-api-key)

Path parameters

platformstringRequired

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

Example: discord

platformUserIdstringRequired

The user's ID on the specified platform

Example: 123456789012345678

programIdstringRequired

The unique identifier for the program/collection

Example: program_123

Responses

200

Successful operation

application/json

Represents a collection challenge or program that users can progress through

idstringOptional

Unique identifier for the program

Example: program_123

namestringOptional

Display name of the program

Example: Winter Challenge

imagestring · uriOptional

URL to the program's image (HTTPS format)

Example: https://example.com/images/winter-challenge.png

descriptionstringOptional

Detailed description of the program's theme and objectives

Example: Collect all winter-themed cards

sizeintegerOptional

Total number of cards in this collection/program

Example: 10

progressInPercentageintegerOptional

User's completion percentage for this collection (0-100)

Example: 30

environmentstringOptional

Environment identifier where this program is active

Example: production

createdTimestampintegerOptional

Timestamp (in milliseconds) when the program was created

Example: 1644825600000

timeLeftintegerOptional

Time remaining in milliseconds until the program ends (not applicable if duration.end is null)

Example: 604800000

statusstring · enumOptional

Current status of the program

Example: in_progressPossible values:

collectedCountintegerOptional

Number of cards the user has collected from this program

Example: 3

400

Bad Request - Missing or invalid parameters

application/json

401

Unauthorized - API key is missing or invalid

application/json

get

/users/{platform}/{platformUserId}/progress/collection-challenges/{programId}

HTTPcURLJavaScriptPython

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
    }
  }
}