Loyi API Reference
  1. Schemas
Loyi API Reference
  • Getting Started
  • Architecture
  • User
    • Users Overview
    • Create user
    • Get users
    • Get user
    • Update user
    • Delete user
  • Reward
    • Rewards Overview
    • Create reward
    • Get rewards
    • Delete reward
    • Create entry pass code
    • Get entry pass code
    • Airdrop reward
    • Award reward
    • Redeem rewards
    • Get owners
  • Collection
    • Collection Overview
    • Create collection
    • Get collections
    • Get collection
    • Update collection
    • Delete collection
    • Get rewards
    • Get owners
  • Collectible
    • Claim collectible
    • Get collectibles
  • Quest
    • Quest Overview
    • Create quest
    • Get quests
    • Get quest
    • Update quest
    • Delete quest
    • Get participants
    • Accept quest
    • Submit answers
    • Get answers
    • Progress quest
  • Leaderboard
    • Leaderboard Overview
    • Award leaders
    • Get leaderboard
  • Leveling
    • Leveling Overview
    • Create leveling configuration
    • Get leveling configuration
    • Configure leveling
    • Get milestone levels
    • Create milestone level
    • Get milestone level
    • Update milestone level
    • Delete milestone level
    • Get users
  • Schemas
    • Response
      • Unauthorized
    • Schemas
      • GenericQuestStep
      • GenericQuestBody
      • GenericQuestTemplate
      • GenericQuestStepStatus
      • Collection
      • CreateCollectionBody
      • UpdateCollectionBody
      • ClaimCollectibleBody
      • CollectibleData
      • CollectionGroup
      • CreateCollectionGroupBody
      • CollectionOwner
      • UpdateCollectionGroupBody
      • GetCollectionOwnersResponse
      • NftData
      • CouponLinkUnique
      • CouponLinkGeneric
      • EntryPass
      • Reward
      • CreateCouponLinkUniqueBody
      • CreateCouponLinkGenericBody
      • CreateEntryPassBody
      • EntryPassCode
      • CreateEntryCodeBody
      • UserWithLevelingProgress
      • GetEntryPassCodeResponse
      • RedeemRewardsResponse
      • RewardOwner
      • User
      • MilestoneLevel
      • LevelingConfiguration
      • GetRewardOwnersResponse
      • ConfigureLevelingBody
      • CreateMilestoneLevelBody
      • CreateUserBody
      • UpdateUserBody
      • GetUsersResponse
      • CollectionQuestTemplate
      • QuizQuestion
      • QuestionnaireQuestion
      • QuizAnswer
      • QuizQuestTemplate
      • QuestionnaireQuestTemplate
      • MilestoneLevelUser
      • Quest
      • CollectionQuestBody
      • GetMilestoneLevelUsersResponse
      • QuizQuestBody
      • QuestionnaireQuestBody
      • CreateQuestBody
      • UpdateQuestBody
      • AcceptQuestBody
      • QuestUserMetadata
      • SubmitQuestAnswersBody
      • SubmitQuestAnswersResponse
      • QuestParticipant
      • Leaderboard
      • CollectionType
      • QuestUserStatus
      • QuestType
      • QuestAttachmentType
      • QuizQuestionType
      • LevelingType
      • GetQuestParticipantsResponse
      • GetLeaderboardResponse
      • Pagination
      • Sorting
      • Filters
      • LeaderboardTimerange
  1. Schemas

Quest

{
    "id": "12345678-1234-1234-1234-123456789012",
    "title": "My Quest",
    "instruction": "My Instruction",
    "completionMessage": "My Completion Message",
    "isActive": true,
    "publicId": "12345678",
    "type": "Collection",
    "steps": 1,
    "rewards": {
        "points": 25,
        "rewards": [
            {
                "id": "123e4567-e89b-12d3-a456-426655440000",
                "title": "Event Entry Pass",
                "description": "An entry pass for the event",
                "instruction": "Show this pass at the event entrance",
                "type": "EntryPass",
                "createdAt": "2022-01-01T00:00:00.000Z",
                "updatedAt": "2022-01-01T00:00:00.000Z"
            }
        ],
        "collections": [
            {
                "id": "123e4567-e89b-12d3-a456-426655440000",
                "publicId": "kdPd_ntE",
                "name": "My Collection",
                "description": "A collection of rewards",
                "image": "https://example.com/image.jpg",
                "amount": 10,
                "collectible": {
                    "imagesURL": "ipfs://example",
                    "metadataURL": "ipfs://example"
                },
                "type": "oneToOne",
                "contractAddress": "0x7B5DF6F27C32cEa2CeF2c4E812c0Ff4d0515B26B",
                "createdAt": "2021-01-01T00:00:00.000Z",
                "updatedAt": "2021-01-01T00:00:00.000Z"
            }
        ]
    },
    "templateId": "12345678-1234-1234-1234-123456789012",
    "template": {
        "collectionIds": [
            "12345678-1234-1234-1234-123456789012"
        ]
    },
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z"
}
Built with