Badge

Get all badges of a user

This endpoint retrives all the badges that the user is associated with.

GEThttps://api.questprotocol.xyz/api/badges

Query parameters

Header parameters

Response

200401500

Successful response

Body

application/json

successboolean

dataarray of object

Request

JavaScriptCurl

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

Response

{
  "success": true,
  "data": [
    {
      "data": {
        "xp": 10,
        "visibility": "OPEN",
        "type": "NONE",
        "remainingCount": 100,
        "createdAt": "2023-05-26T14:44:19.220Z",
        "badgeId": "dummy-id",
        "entityId": "e-000001",
        "name": "dummy-badge-name",
        "imageIPFS": "QmXdzQQ238rkdiM7i9YgXXEtm5n3Fypw9r6QPVtwjNMGzW",
        "description": "dummy-description",
        "skills": [
          {
            "skillId": "123",
            "score": 123
          }
        ],
        "badgeContractTokenId": "dummy-token",
        "endsAt": 1685198841965,
        "typeData": [
          "t"
        ],
        "proofType": "Proof of Appreciation",
        "createdBy": "u-0000001"
      },
      "inDyNFT": false,
      "claimed": false,
      "claimStatus": "UNCLAIMED"
    }
  ]
}

Get all badges created by a user

This endpoint retrives all the badges a user has created.

GEThttps://api.questprotocol.xyz/api/users/{userId}/created-badges

Path parameters

userId*string

Header parameters

Response

200401500

Successful response

Body

application/json

successboolean

dataarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}/created-badges', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "data": {
        "xp": 10,
        "visibility": "OPEN",
        "type": "NONE",
        "remainingCount": 100,
        "createdAt": "2023-05-26T14:44:19.220Z",
        "badgeId": "dummy-id",
        "entityId": "e-000001",
        "name": "dummy-badge-name",
        "imageIPFS": "QmXdzQQ238rkdiM7i9YgXXEtm5n3Fypw9r6QPVtwjNMGzW",
        "description": "dummy-description",
        "skills": [
          {
            "skillId": "123",
            "score": 123
          }
        ],
        "badgeContractTokenId": "dummy-token",
        "endsAt": 1685198841965,
        "typeData": [
          "t"
        ],
        "proofType": "Proof of Appreciation",
        "createdBy": "u-0000001"
      },
      "inDyNFT": false,
      "claimed": false,
      "claimStatus": "UNCLAIMED"
    }
  ]
}

Get all badges of an entity

This endpoint retrives all the badges associated with an entity.

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

Path parameters

entityId*string

Query parameters

Header parameters

Response

200500

Successful response

Body

application/json

successboolean

dataarray of object

Request

JavaScriptCurl

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

Response

{
  "success": true,
  "data": [
    {
      "data": {
        "xp": 10,
        "visibility": "OPEN",
        "type": "NONE",
        "remainingCount": 100,
        "createdAt": "2023-05-26T14:44:19.220Z",
        "badgeId": "dummy-id",
        "entityId": "e-000001",
        "name": "dummy-badge-name",
        "imageIPFS": "QmXdzQQ238rkdiM7i9YgXXEtm5n3Fypw9r6QPVtwjNMGzW",
        "description": "dummy-description",
        "skills": [
          {
            "skillId": "123",
            "score": 123
          }
        ],
        "badgeContractTokenId": "dummy-token",
        "endsAt": 1685198841965,
        "typeData": [
          "t"
        ],
        "proofType": "Proof of Appreciation",
        "createdBy": "u-0000001"
      },
      "inDyNFT": false,
      "claimed": false,
      "claimStatus": "UNCLAIMED"
    }
  ]
}

Add badge for an entity

This endpoint adds a badge for an entity.

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

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

name*string

imageIPFS*string

description*string

skillsarray of object

userIdsarray of string

endsAtinteger (int64)

xpnumber

airdropEnabledboolean

typeDataobject

typestring

totalCountnumber

visibilitystring

proofTypestring

Response

200400401500

Successful response

Body

application/json

successboolean

badgeIdstring

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/badges', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "dummy-name",
      "imageIPFS": "dummy-hash",
      "description": "dummy-description"
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "badgeId": "badge-1212122"
}

Get badge details of an entity

This endpoint retrives the badge details associated with an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/badges/{badgeId}

Path parameters

entityId*string

badgeId*string

Query parameters

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

dataobject

Request

JavaScriptCurl

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

Response

{
  "success": true,
  "data": {
    "badge_data": {
      "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"
    },
    "skills_data": [
      {
        "skillId": "skil-12",
        "score": 20,
        "name": "Java",
        "description": "sun-microsystem's java",
        "isEnabled": true
      }
    ],
    "entity_data": {
      "id": "entity123",
      "entityURLAlias": "my-entity",
      "entityRecordIds": [
        "record1",
        "record2"
      ],
      "contracts": [
        "contract1",
        "contract2"
      ],
      "badgeContractAddress": "0x123abc",
      "dyNFTContractAddress": "0x456def",
      "themeContractAddress": "0x789ghi",
      "name": "My Entity",
      "openseaSlug": "my-entity-slug",
      "description": "This is my entity description.",
      "twitter": "myentity",
      "discord": "myentity#1234",
      "telegram": "myentity",
      "instagram": "myentity",
      "website": "https://myentity.com",
      "medium": "myentity",
      "imageUrl": "https://example.com/myentity.jpg",
      "bannerUrl": "https://example.com/myentity-banner.jpg",
      "isEnabled": false,
      "isPrivate": false,
      "chainSource": "OFF_CHAIN",
      "defaultDyNftThemeId": "0",
      "discordQuestWebhookURL": "https://example.com/discord-webhook",
      "modifiedAt": "2023-06-27T12:45:00Z",
      "createdAt": "2023-06-25T09:00:00Z",
      "plan": "FREE",
      "parentEntityId": "e-0000001"
    },
    "claimedUsers": [
      {
        "userId": "user-123"
      }
    ],
    "unclaimedUsers": [
      {
        "userId": "user-123"
      }
    ],
    "isOwner": true,
    "stats": {
      "claimedCount": 10,
      "unclaimedCount": 5
    },
    "claimStatus": "NOT_WHITELISTED"
  }
}

Update badge

This endpoint updates a badge of an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/badges/{badgeId}/update

Path parameters

entityId*string

badgeId*string

Header parameters

Body

application/json

namestring

imageIPFSstring

descriptionstring

typestring

skillsarray of object

endsAtnumber

xpnumber

typeDataobject

Response

200400401500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/badges/{badgeId}/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Claim badge for an entity

This endpoint allows users to claim a badge for an entity

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/badges/{badgeId}/claim

Path parameters

entityId*string

badgeId*string

Query parameters

Header parameters

Body

application/json

addToDynamicNFTboolean

Response

200400401500

Successful response

Body

application/json

successboolean

nftMintedboolean

calculatedDynamicNFTboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/badges/{badgeId}/claim', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true,
  "nftMinted": true,
  "calculatedDynamicNFT": true
}

Add users to badge

This endpoint allows an admin to add users to a Badge.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/badges/{badgeId}/users

Path parameters

entityId*string

badgeId*string

Query parameters

Header parameters

Body

application/json

userIds*array of string

Response

200400500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/badges/{badgeId}/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userIds": [
        "user-1",
        "user-2"
      ]
    }),
});
const data = await response.json();

Response

{
  "success": true
}

Get Badges Count for User

Retrieve the number of badges earned by a specific user within a particular entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/badges-count

Path parameters

entityId*string

The unique identifier of the entity.

userId*string

The unique identifier of the user within the entity.

Header parameters

Response

200401500

Successful response

Body

application/json

successboolean

datanumber

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/badges-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "data": 5
}

Get User Earned Badges for Entity

Retrieve the badges earned by a specific user within a particular entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/badges

Path parameters

entityId*string

The unique identifier of the entity.

userId*string

The unique identifier of the user within the entity.

Query parameters

Header parameters

Response

200401500

Successful response

Body

application/json

successboolean

dataarray of Badge (object)

pageinteger

totalCountinteger

totalPagesinteger

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/badges', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "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"
    }
  ],
  "page": 1,
  "totalCount": 10,
  "totalPages": 1
}