Campaign | Quest Protocol

Quest Protocol

Get all campaigns

This endpoint retrieves all the active campaigns.

get

/quests

Query parameters

pagestring

The page number of expected set of documents.

Example: 1

limitstring

The limit of the number of documents each page.

Example: 10

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/quests' \
  --header 'apikey: test'

200

500

{
  "success": true,
  "data": {
    "questId": "quest123",
    "entityId": "entity123",
    "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,
    "theme": {},
    "minXPThreshold": 50,
    "createdAt": "2023-06-27T12:45:00Z",
    "eligibilityCriterias": [
      "criteria1",
      "criteria2"
    ],
    "rewards": [
      "reward1",
      "reward2"
    ],
    "skills": [
      {
        "skillId": "skill1",
        "score": 80
      },
      {
        "skillId": "skill2",
        "score": 60
      }
    ]
  }
}

Successful response

Get all campaigns for an entity

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

get

/entities/{entityId}/quests

Path parameters

entityIdstringrequired

Query parameters

pagestring

The page number of expected set of documents.

Example: 1

limitstring

The limit of the number of documents each page.

Example: 10

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests' \
  --header 'apikey: test'

200

500

{
  "success": true,
  "data": {
    "questId": "quest123",
    "entityId": "entity123",
    "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,
    "theme": {},
    "minXPThreshold": 50,
    "createdAt": "2023-06-27T12:45:00Z",
    "eligibilityCriterias": [
      "criteria1",
      "criteria2"
    ],
    "rewards": [
      "reward1",
      "reward2"
    ],
    "skills": [
      {
        "skillId": "skill1",
        "score": 80
      },
      {
        "skillId": "skill2",
        "score": 60
      }
    ]
  }
}

Successful response

Create campaign

This endpoint allows to create a campaign.

post

/entities/{entityId}/quests

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Body

titlestringrequired

Example: Title of this campaign

descriptionstring

Example: Description of this campaign

imageURLstring

Example: https://www.myimage.com

endsAtnumber

Example: 72000

hasReferralboolean

Example: false

themeobject

eligibilityCriteriasobject[]required

Example: [{"type":"USER_INPUT_TEXT","data":{"title":"Enter your name","xp":20,"frequency":"ONCE"}}]

rewardsobject[]required

Example: [{"type":"REWARD_BADGE","title":"Dummy badge","imageIPFS":"ipfs-hash","description":"badge description"}]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Title of this campaign",
    "description": "Description of this campaign",
    "imageURL": "https://www.myimage.com",
    "endsAt": 72000,
    "hasReferral": false,
    "theme": {},
    "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": "badge description"
      }
    ]
  }'

200

400

401

500

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

Successful response

Get campaign details

This endpoint retrieves the details of a specific campaign.

get

/entities/{entityId}/quests/{questId}

Path parameters

entityIdstringrequired

questIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}?userId=dummy-userid' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'apikey: test'

200

401

500

{
  "success": true,
  "data": {
    "questId": "quest123",
    "entityId": "entity123",
    "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,
    "theme": {},
    "minXPThreshold": 50,
    "createdAt": "2023-06-27T12:45:00Z",
    "eligibilityCriterias": [
      "criteria1",
      "criteria2"
    ],
    "rewards": [
      "reward1",
      "reward2"
    ],
    "skills": [
      {
        "skillId": "skill1",
        "score": 80
      },
      {
        "skillId": "skill2",
        "score": 60
      }
    ]
  },
  "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,
      "isEnabled": true,
      "visibility": "LIMITED",
      "type": "DISCORD",
      "proofType": "Type A",
      "endsAt": 1678900000,
      "remainingCount": 5,
      "createdBy": "user123",
      "createdAt": "2023-06-27T12:45:00Z",
      "typeData": {
        "key1": "value1",
        "key2": "value2"
      },
      "skills": [
        {
          "skillId": "skill1",
          "score": 80
        },
        {
          "skillId": "skill2",
          "score": 60
        }
      ]
    }
  ],
  "eligibilityData": [
    {
      "data": {
        "criteriaId": "criteria123",
        "questId": "quest123",
        "label": "Criteria Label",
        "xp": 50,
        "requiresApproval": true,
        "createdAt": "2023-06-27T12:45:00Z",
        "frequency": "DAILY",
        "criteriaType": "TWITTER_LIKE_POST",
        "dependentCriterias": [
          "dependent1",
          "dependent2"
        ],
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        }
      },
      "completed": true,
      "isLocked": false,
      "unfinishedCriteriaIds": [
        "criteria1",
        "criteria2"
      ],
      "userAnswer": [
        "answer1",
        "answer2"
      ]
    }
  ]
}

Successful response

Get campaign summary

This endpoint retrieves the campaign summary.

get

/entities/{entityId}/quests/{questId}/summary

Path parameters

entityIdstringrequired

questIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/summary' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "summary": {
    "quest": {
      "questId": "quest123",
      "entityId": "entity123",
      "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,
      "theme": {},
      "minXPThreshold": 50,
      "createdAt": "2023-06-27T12:45:00Z",
      "eligibilityCriterias": [
        "criteria1",
        "criteria2"
      ],
      "rewards": [
        "reward1",
        "reward2"
      ],
      "skills": [
        {
          "skillId": "skill1",
          "score": 80
        },
        {
          "skillId": "skill2",
          "score": 60
        }
      ]
    },
    "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"
      }
    ],
    "answers": [
      {
        "question": "What is your name ?",
        "answers": [
          {
            "userId": "u-1234",
            "name": "Jon",
            "imageUrl": "image-ipfs-hash",
            "userAnswer": [
              "jon"
            ]
          }
        ]
      }
    ]
  }
}

Successful response

Update campaign details

This endpoint allows an admin to update a campaign.

post

/entities/{entityId}/quests/{questId}/update

Path parameters

entityIdstringrequired

questIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

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

eligibilityCriteriaIdsToDeletestring[]

rewardIdsToDeletestring[]

eligibilityCriteriasobject[]

Example: [{"type":"USER_INPUT_TEXT","data":{"title":"Enter your name","xp":20,"frequency":"ONCE"}}]

rewardsobject[]

Example: [{"type":"REWARD_BADGE","title":"Dummy badge","imageIPFS":"ipfs-hash","description":"badge description"}]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/update' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Title of this campaign",
    "description": "Description of this campaign",
    "imageURL": "https://www.myimage.com",
    "endsAt": 72000,
    "hasReferral": false,
    "theme": {},
    "eligibilityCriteriaIdsToDelete": [
      "ec-101"
    ],
    "rewardIdsToDelete": [
      "r-101"
    ],
    "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": "badge description"
      }
    ]
  }'

200

401

500

{
  "success": true
}

Successful response

Delete campaign

This endpoint allows an admin to delete a campaign.

post

/entities/{entityId}/quests/{questId}/delete

Path parameters

entityIdstringrequired

questIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/delete' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

400

401

500

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

Successful response

Verify campaign criteria

This endpoint allows users to verify an eligibility criteria.

post

/entities/{entityId}/quests/{questId}/verify

Path parameters

entityIdstringrequired

questIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

criteriaIdstring

Example: criteria-123

answersstring[]

Example: ["answer1","answer2"]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/verify' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "criteriaId": "criteria-123",
    "answers": [
      "answer1",
      "answer2"
    ]
  }'

200

400

401

500

{
  "success": true
}

Successful response

Claim campaign rewards

This endpoint allows a user to claim rewards.

post

/entities/{entityId}/quests/{questId}/claim

Path parameters

entityIdstringrequired

questIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

userIdstring

Example: user-123

referralCodestring

Example: referal-code

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/claim?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "user-123",
    "referralCode": "referal-code"
  }'

200

400

401

500

{
  "success": true
}

Successful response

Claim campaign rewards

This endpoint allows a user to claim rewards.

post

/entities/{entityId}/quests/{questId}/claim-multiple

Path parameters

entityIdstringrequired

questIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

referer;string

Body

userIdstring

Example: user-123

referralCodestring

Example: referal-code

addToDynamicNFTboolean

questIdsstring[]

failedClaimsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/claim-multiple?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "user-123",
    "referralCode": "referal-code",
    "addToDynamicNFT": true,
    "questIds": [
      "text"
    ],
    "failedClaims": [
      "text"
    ]
  }'

200

400

401

500

{
  "success": true
}

Successful response

New referal code for campaign and user

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

get

/entities/{entityId}/quests/{questId}/users/{userId}/referralcode

Path parameters

entityIdstringrequired

questIdstringrequired

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/users/{userId}/referralcode' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

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

Successful response

Get Multiples Quests

This endpoint retreives multiple campaigns

get

/entities/{entityId}/multiple-quests

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

detailsPagestring

pagenumber

limitnumber

selectedOptionstring

getTopQuestboolean

sortByPrioritystring

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/multiple-quests?userId=text' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "page": 5,
  "totalPages": 25,
  "totalQuests": 100,
  "quests": [
    {
      "questId": "quest123",
      "entityId": "entity123",
      "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,
      "theme": {},
      "minXPThreshold": 50,
      "createdAt": "2023-06-27T12:45:00Z",
      "eligibilityCriterias": [
        "criteria1",
        "criteria2"
      ],
      "rewards": [
        "reward1",
        "reward2"
      ],
      "skills": [
        {
          "skillId": "skill1",
          "score": 80
        },
        {
          "skillId": "skill2",
          "score": 60
        }
      ]
    }
  ]
}

Successful response

Verify multiple campaign criteria

This endpoint allows users to verify an eligibility criteria.

post

/entities/{entityId}/quests/{questId}/verify-all

Path parameters

entityIdstringrequired

questIdstringrequired

Query parameters

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

referralCodestring

Example: xhy1245

userIdstring

Example: 1

sessionstring

criteriasobject[]

Example: [{"criteriaId":"exm-1233","answer":["option1","option3"]}]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/verify-all?userId=text' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "referralCode": "xhy1245",
    "userId": "1",
    "session": "",
    "criterias": [
      {
        "criteriaId": "exm-1233",
        "answer": [
          "option1",
          "option3"
        ]
      }
    ]
  }'

200

400

401

500

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

Successful response

Get referal leaderboard

This endpoint retrieves the referal leaderboard stats.

get

/entities/{entityId}/quests/{questId}/referraldashboard

Path parameters

entityIdstringrequired

questIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/referraldashboard' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

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

Successful response

Get eligibility criteria for a quest

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

get

/entities/{entityId}/quests/{questId}/criterias

Path parameters

entityIdstringrequired

The ID of the entity.

questIdstringrequired

The ID of the quest.

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/criterias?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "questId": "quest-123",
    "entityId": "entity-456",
    "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",
    "eligibilityCriterias": [
      "criteria-789"
    ],
    "rewards": [
      [
        "XP",
        "Badge"
      ]
    ]
  }
}

Successful response

Create Multiple Default Quests

Create multiple default quests for a specified entity.

post

/entities/{entityId}/default-multi-quest

Path parameters

entityIdstringrequired

The ID of the entity for which quests are created.

Body

defaultIdsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/default-multi-quest' \
  --header 'Content-Type: application/json' \
  --data '{
    "defaultIds": [
      "defaultId1",
      "defaultId2"
    ]
  }'

200

400

401

500

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

Success

Create a default quest for the entity

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

post

/entities/{entityId}/default-quest

Path parameters

entityIdstringrequired

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

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

defaultIdstringrequired

The ID of the default quest (optional).

Example: default-id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/default-quest?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "defaultId": "default-id"
  }'

200

400

401

500

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

Successful response

Set the status of a quest

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

post

/entities/{entityId}/quests/{questId}/setstatus

Path parameters

entityIdstringrequired

questIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

statusstring · enum

Example: ACTIVE

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/setstatus' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "ACTIVE"
  }'

200

400

401

500

{
  "success": true
}

Successful response

Get quest submissions

This endpoint allows users to get submissions for a quest.

get

/entities/{entityId}/quests/{questId}/submissions

Path parameters

entityIdstringrequired

questIdstringrequired

Query parameters

parentEntityIdstring

userIdstring

pageinteger · min: 1 · default: 1

limitinteger · min: 1 · default: 10

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/submissions' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

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

Successful response

Get quest answers

This endpoint allows users to get answers for a quest.

get

/entities/{entityId}/quests/{questId}/answers

Path parameters

entityIdstringrequired

questIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/quests/{questId}/answers' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

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

Successful response

Get new criteria session

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

get

/entities/{entityId}/new-session

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/new-session' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

401

500

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

Successful response

Create metric quest

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

post

/entities/{entityId}/metric-quests

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

titlestring

Title of the quest

Example: exam-title

descriptionstring

Description of the quest

Example: exam-desc

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)

rewardsobject[]

metricobject

Metric details

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/metric-quests' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "exam-title",
    "description": "exam-desc",
    "endsAt": "text",
    "autoClaimRewards": true,
    "repeatRewardsBasedOnMetricCount": true,
    "metadata": {},
    "priority": 1,
    "rewards": [
      {}
    ],
    "metric": {
      "metricId": "text",
      "threshold": 1,
      "autoClaimRewards": true,
      "repeatRewardsBasedOnMetricCount": true,
      "metricType": "threshold"
    }
  }'

200

400

401

500

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

Successful response

Get details of a metric-based quest

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

get

/entities/{entityId}/metric-quests/{questId}

Path parameters

entityIdstringrequired

questIdstringrequired

Query parameters

userIdstring

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/metric-quests/{questId}' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

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

Successful response