Campaign

Get all campaigns

This endpoint retrieves all the active campaigns.

GEThttps://api.questprotocol.xyz/api/quests

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataCampaign (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/quests', {
    method: 'GET',
    headers: {
      "apikey": "test"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "questId": "quest123",
    "entityId": "entity123",
    "eligibilityCriterias": [
      "criteria1",
      "criteria2"
    ],
    "rewards": [
      "reward1",
      "reward2"
    ],
    "title": "My campaign",
    "description": "This is my campaign description.",
    "imageURL": "https://example.com/campaign-image.jpg",
    "endsAt": "2023-06-30T23:59:59Z",
    "isDeleted": false,
    "hasReferral": false,
    "referralXP": 50,
    "visibility": "LIMITED",
    "status": "ACTIVE",
    "xp": 100,
    "skills": [
      {
        "skillId": "skill1",
        "score": 80
      },
      {
        "skillId": "skill2",
        "score": 60
      }
    ],
    "minXPThreshold": 50,
    "createdAt": "2023-06-27T12:45:00Z"
  }
}

Get all campaigns for an entity

This endpoint retrieves all the active campaigns of a specific entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests

Path parameters

entityId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataCampaign (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests', {
    method: 'GET',
    headers: {
      "apikey": "test"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "questId": "quest123",
    "entityId": "entity123",
    "eligibilityCriterias": [
      "criteria1",
      "criteria2"
    ],
    "rewards": [
      "reward1",
      "reward2"
    ],
    "title": "My campaign",
    "description": "This is my campaign description.",
    "imageURL": "https://example.com/campaign-image.jpg",
    "endsAt": "2023-06-30T23:59:59Z",
    "isDeleted": false,
    "hasReferral": false,
    "referralXP": 50,
    "visibility": "LIMITED",
    "status": "ACTIVE",
    "xp": 100,
    "skills": [
      {
        "skillId": "skill1",
        "score": 80
      },
      {
        "skillId": "skill2",
        "score": 60
      }
    ],
    "minXPThreshold": 50,
    "createdAt": "2023-06-27T12:45:00Z"
  }
}

Create campaign

This endpoint allows to create a campaign.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/quests

Path parameters

entityId*string

Query parameters

Header parameters

Body

title*string

Example: "Title of this campaign"

descriptionstring

Example: "Description of this campaign"

imageURLstring

Example: "https://www.myimage.com"

endsAtnumber

Example: 72000

hasReferralboolean

Example: false

themeobject

eligibilityCriterias*array of object

rewards*array of object

Response

Successful response

Body

successboolean

Example: true

qidstring

Example: "campaign-202"

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "Title of this campaign",
      "eligibilityCriterias": [
        {
          "type": "USER_INPUT_TEXT",
          "data": {
            "title": "Enter your name",
            "xp": 20,
            "frequency": "ONCE"
          }
        }
      ],
      "rewards": [
        {
          "type": "REWARD_BADGE",
          "title": "Dummy badge",
          "imageIPFS": "ipfs-hash",
          "description": "<p>badge description</p>",
          "__$markdownParsed": true
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "qid": "campaign-202"
}

Get campaign details

This endpoint retrieves the details of a specific campaign.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}

Path parameters

entityId*string

questId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataCampaign (object)

eligibilityDataarray of object

allCriteriasCompletedboolean

Example: true

claimStatusboolean

Example: true

totalClaimednumber

Example: 2

rewardsarray of Badge (object)

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "userid": "dummy-userid",
      "token": "dummy-token",
      "apikey": "test"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "questId": "quest123",
    "entityId": "entity123",
    "eligibilityCriterias": [
      "criteria1",
      "criteria2"
    ],
    "rewards": [
      "reward1",
      "reward2"
    ],
    "title": "My campaign",
    "description": "This is my campaign description.",
    "imageURL": "https://example.com/campaign-image.jpg",
    "endsAt": "2023-06-30T23:59:59Z",
    "isDeleted": false,
    "hasReferral": false,
    "referralXP": 50,
    "visibility": "LIMITED",
    "status": "ACTIVE",
    "xp": 100,
    "skills": [
      {
        "skillId": "skill1",
        "score": 80
      },
      {
        "skillId": "skill2",
        "score": 60
      }
    ],
    "minXPThreshold": 50,
    "createdAt": "2023-06-27T12:45:00Z"
  },
  "eligibilityData": [
    {
      "data": {
        "criteriaId": "criteria123",
        "questId": "quest123",
        "label": "Criteria Label",
        "xp": 50,
        "dependentCriterias": [
          "dependent1",
          "dependent2"
        ],
        "requiresApproval": false,
        "frequency": "DAILY",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "criteriaType": "TWITTER_LIKE_POST",
        "createdAt": "2023-06-27T12:45:00Z"
      },
      "completed": true,
      "isLocked": false,
      "unfinishedCriteriaIds": [
        "criteria1",
        "criteria2"
      ],
      "userAnswer": [
        "answer1",
        "answer2"
      ]
    }
  ],
  "allCriteriasCompleted": true,
  "claimStatus": true,
  "totalClaimed": 2,
  "rewards": [
    {
      "badgeId": "badge123",
      "entityId": "entity123",
      "badgeContractTokenId": "token123",
      "name": "My Badge",
      "imageIPFS": "https://example.com/badge-image.jpg",
      "description": "This is my badge description.",
      "xp": 100,
      "skills": [
        {
          "skillId": "skill1",
          "score": 80
        },
        {
          "skillId": "skill2",
          "score": 60
        }
      ],
      "isEnabled": false,
      "visibility": "LIMITED",
      "type": "DISCORD",
      "typeData": {
        "key1": "value1",
        "key2": "value2"
      },
      "proofType": "Type A",
      "endsAt": 1678900000,
      "remainingCount": 5,
      "createdBy": "user123",
      "createdAt": "2023-06-27T12:45:00Z"
    }
  ]
}

Get campaign summary

This endpoint retrieves the campaign summary.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/summary

Path parameters

entityId*string

questId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

summaryobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/summary', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "summary": {
    "quest": {
      "questId": "quest123",
      "entityId": "entity123",
      "eligibilityCriterias": [
        "criteria1",
        "criteria2"
      ],
      "rewards": [
        "reward1",
        "reward2"
      ],
      "title": "My campaign",
      "description": "This is my campaign description.",
      "imageURL": "https://example.com/campaign-image.jpg",
      "endsAt": "2023-06-30T23:59:59Z",
      "isDeleted": false,
      "hasReferral": false,
      "referralXP": 50,
      "visibility": "LIMITED",
      "status": "ACTIVE",
      "xp": 100,
      "skills": [
        {
          "skillId": "skill1",
          "score": 80
        },
        {
          "skillId": "skill2",
          "score": 60
        }
      ],
      "minXPThreshold": 50,
      "createdAt": "2023-06-27T12:45:00Z"
    },
    "answers": [
      {
        "question": "What is your name ?",
        "answers": [
          {
            "userAnswer": [
              "jon"
            ],
            "userId": "u-1234",
            "name": "Jon",
            "imageUrl": "image-ipfs-hash"
          }
        ]
      }
    ],
    "questStats": [
      {
        "viewCount": 10,
        "claimCount": 5,
        "date": "2023-06-27T12:45:00Z",
        "entityId": "e-101010",
        "questId": "q-101010",
        "createdAt": "2023-06-27T12:45:00Z",
        "updatedAt": "2023-06-27T12:45:00Z"
      }
    ]
  }
}

Update campaign details

This endpoint allows an admin to update a campaign.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/update

Path parameters

entityId*string

questId*string

Header parameters

Body

titlestring

Example: "Title of this campaign"

descriptionstring

Example: "Description of this campaign"

imageURLstring

Example: "https://www.myimage.com"

endsAtnumber

Example: 72000

hasReferralboolean

Example: false

themeobject

eligibilityCriteriasarray of object

rewardsarray of object

eligibilityCriteriaIdsToDeletearray of string

rewardIdsToDeletearray of string

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/update', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Delete campaign

This endpoint allows an admin to delete a campaign.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/delete

Path parameters

entityId*string

questId*string

Header parameters

Body

The request body is an empty object

object

Response

Successful response

Body

successboolean

Example: true

messagestring

Example: "Campaign deleted successfully"

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/delete', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "message": "Campaign deleted successfully"
}

Verify campaign criteria

This endpoint allows users to verify an eligibility criteria.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/verify

Path parameters

entityId*string

questId*string

Header parameters

Body

criteriaIdstring

Example: "criteria-123"

answersarray of string

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/verify', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Claim campaign rewards

This endpoint allows a user to claim rewards.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/claim

Path parameters

entityId*string

questId*string

Query parameters

Header parameters

Body

userIdstring

Example: "user-123"

referralCodestring

Example: "referal-code"

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/claim?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Claim campaign rewards

This endpoint allows a user to claim rewards.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/claim-multiple

Path parameters

entityId*string

questId*string

Query parameters

Header parameters

Body

userIdstring

Example: "user-123"

referralCodestring

Example: "referal-code"

questIdsarray of string

addToDynamicNFTboolean

failedClaimsarray of string

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/claim-multiple?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

New referal code for campaign and user

This endpoint allows ato get or set a new refereal code associated with a campaign and user.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/users/{userId}/referralcode

Path parameters

entityId*string

questId*string

userId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

referralCodestring

Example: "referal-code"

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/users/{userId}/referralcode', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "referralCode": "referal-code"
}

Get Multiples Quests

This endpoint retreives multiple campaigns

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/multiple-quests

Path parameters

entityId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

questsarray of Campaign (object)

pageinteger

Example: 5

totalPagesinteger

Example: 25

totalQuestsinteger

Example: 100

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/multiple-quests?userId=text', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "quests": [
    {
      "questId": "quest123",
      "entityId": "entity123",
      "eligibilityCriterias": [
        "criteria1",
        "criteria2"
      ],
      "rewards": [
        "reward1",
        "reward2"
      ],
      "title": "My campaign",
      "description": "This is my campaign description.",
      "imageURL": "https://example.com/campaign-image.jpg",
      "endsAt": "2023-06-30T23:59:59Z",
      "isDeleted": false,
      "hasReferral": false,
      "referralXP": 50,
      "visibility": "LIMITED",
      "status": "ACTIVE",
      "xp": 100,
      "skills": [
        {
          "skillId": "skill1",
          "score": 80
        },
        {
          "skillId": "skill2",
          "score": 60
        }
      ],
      "minXPThreshold": 50,
      "createdAt": "2023-06-27T12:45:00Z"
    }
  ],
  "page": 5,
  "totalPages": 25,
  "totalQuests": 100
}

Verify multiple campaign criteria

This endpoint allows users to verify an eligibility criteria.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/verify-all

Path parameters

entityId*string

questId*string

Query parameters

Header parameters

Body

referralCodestring

Example: "xhy1245"

criteriasarray of object

userIdstring

Example: "1"

sessionstring

Example: ""

Response

Successful response

Body

successboolean

Example: true

failedCriteriasarray of string

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/verify-all?userId=text', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true,
  "failedCriterias": [
    "criteriasId1",
    "criteriasId2"
  ]
}

Get referal leaderboard

This endpoint retrieves the referal leaderboard stats.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/referraldashboard

Path parameters

entityId*string

questId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/referraldashboard', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "userId": "user-123",
    "name": "jon-doe",
    "count": 10
  }
}

Get eligibility criteria for a quest

Retrieve eligibility criteria for a specific quest associated with an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/criterias

Path parameters

entityId*string

The ID of the entity.

questId*string

The ID of the quest.

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/criterias?userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "questId": "quest-123",
    "entityId": "entity-456",
    "eligibilityCriterias": [
      "criteria-789"
    ],
    "rewards": [
      [
        "XP",
        "Badge"
      ]
    ],
    "title": "Explore the Unknown",
    "description": "Embark on a journey to discover hidden treasures.",
    "imageURL": "https://example.com/images/quest.png",
    "endsAt": "2023-12-31T23:59:59Z"
  }
}

Create Multiple Default Quests

Create multiple default quests for a specified entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/default-multi-quest

Path parameters

entityId*string

The ID of the entity for which quests are created.

Body

defaultIdsarray of string

Response

Success

Body

successboolean

dataarray of object

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/default-multi-quest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "defaultIds": [
        "defaultId1",
        "defaultId2"
      ]
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "success": true,
      "id": "exm-id",
      "title": "title",
      "description": "description",
      "imageURL": "www.questlabs.ai",
      "endsAt": "text"
    }
  ]
}

Create a default quest for the entity

This endpoint allows users to create a default quest for the specified entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/default-quest

Path parameters

entityId*string

The ID of the entity for which the quest will be created.

Query parameters

Header parameters

Body

defaultId*string

The ID of the default quest (optional).

Example: "default-id"

Response

Successful response

Body

successboolean

Example: true

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/default-quest?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "defaultId": "default-id"
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "success": true,
    "id": "q-123"
  }
}

Set the status of a quest

This endpoint allows users to set the status of a quest.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/setstatus

Path parameters

entityId*string

questId*string

Header parameters

Body

statusenum

Example: "ACTIVE"

ACTIVEINACTIVE

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/setstatus', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Get quest submissions

This endpoint allows users to get submissions for a quest.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/submissions

Path parameters

entityId*string

questId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataarray of object

totalDocumentsinteger

Example: 20

totalPagesinteger

Example: 2

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/submissions', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "decryptedEmail": "[email protected]",
      "usersReferred": 3,
      "referredBy": "[email protected]",
      "submittedAt": "2023-12-11T12:34:56Z",
      "userId": "123",
      "referralCode": "abc123"
    }
  ],
  "totalDocuments": 20,
  "totalPages": 2
}

Get quest answers

This endpoint allows users to get answers for a quest.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/answers

Path parameters

entityId*string

questId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/answers', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "answers": [
      {
        "userId": "123",
        "name": "John Doe",
        "imageUrl": "https://example.com/image.jpg",
        "session": "session123",
        "question1": "Answer 1",
        "question2": "Answer 2"
      }
    ],
    "questions": [
      "Question 1",
      "Question 2"
    ]
  }
}

Get new criteria session

This endpoint allows users to get a new session for eligibility criteria.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/new-session

Path parameters

entityId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

datastring

Example: "1635869520123-123e4567-e89b-12d3-a456-426614174001"

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/new-session', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": "1635869520123-123e4567-e89b-12d3-a456-426614174001"
}

Create metric quest

This endpoint allows users to create a metric-based quest.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/metric-quests

Path parameters

entityId*string

Header parameters

Body

Request body for creating metric quest

titlestring

Title of the quest

Example: "exam-title"

descriptionstring

Description of the quest

Example: "exam-desc"

metricobject

Metric details

rewardsarray of object

endsAtstring

End date of the quest

autoClaimRewardsboolean

Auto claim rewards flag

repeatRewardsBasedOnMetricCountboolean

Repeat rewards based on metric count flag

metadataobject

Additional metadata for the quest

prioritynumber

Priority of the quest (1-5)

Response

Successful response

Body

successboolean

Example: true

questIdstring

Example: "q-123e4567-e89b-12d3-a456-426614174000"

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/metric-quests', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true,
  "questId": "q-123e4567-e89b-12d3-a456-426614174000"
}

Get details of a metric-based quest

Retrieves detailed information about a metric-based quest, including quest details, rewards, and user progress.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/metric-quests/{questId}

Path parameters

entityId*string

questId*string

Query parameters

Header parameters

Response

Successful response

Body

successboolean

Indicates if the request was successful

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/metric-quests/{questId}', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "quest": {
      "questId": "text",
      "entityId": "text",
      "title": "text",
      "description": "text",
      "imageURL": "text",
      "endsAt": "text",
      "status": "text",
      "xp": 0,
      "skills": [
        {
          "name": "text",
          "skillId": "text",
          "score": 0
        }
      ]
    },
    "rewards": [
      {
        "rewardId": "text"
      }
    ],
    "metricDetails": {
      "metricId": "text",
      "entityId": "text",
      "metricType": "text",
      "threshold": 0,
      "autoClaimRewards": false,
      "repeatRewardsBasedOnMetricCount": false
    },
    "claimStatus": false
  }
}

PreviousBadge NextApp Metric

Last updated 10 months ago