Membership Card | Quest Protocol

Quest Protocol

Add running xp

This endpoint allows add running xp for a user.

post

/entities/{entityId}/add-xp

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

Body

xpnumber

Example: 10

forUserIdstring

Example: user-123

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/add-xp?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "xp": 10,
    "forUserId": "user-123"
  }'

200

400

500

{
  "success": true
}

Successful response

Get Membership for user

This endpoint allows get running xp for a user.

get

/entities/{entityId}/users/{userId}/xp

Path parameters

entityIdstringrequired

userIdstringrequired

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}/users/{userId}/xp?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

404

500

{
  "success": true,
  "data": 1,
  "tier": 1,
  "xpThreshold": 1
}

Successful response

Get DynamicNft for user

This endpoint allows get Multiple DynamicNft for a user.

post

/entities/{entityId}/users/xp

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

Body

userIdsstring[]

Example: ["userid-123","userid-456"]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/xp?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "userIds": [
      "userid-123",
      "userid-456"
    ]
  }'

200

400

401

404

500

{
  "success": true,
  "data": [
    {
      "userId": "text",
      "entityId": "text",
      "type": "text",
      "membershipTier": 1,
      "runningXP": 1,
      "totalXP": 1,
      "nftTokenId": "text",
      "name": "text",
      "title": "text",
      "description": "text",
      "image": "text",
      "animation_url": "text",
      "metadataIPFS": "text",
      "createdAt": "2025-02-28T07:15:20.824Z",
      "attributes": [
        {
          "display_type": "text",
          "trait_type": "text",
          "value": "text",
          "image": "text",
          "item_type": "text"
        }
      ]
    }
  ]
}

Successful response

Get all membership cards of a user

This endpoint retrieves membership cards for a user.

get

/mynfts

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/mynfts?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": [
    {
      "userId": "user123",
      "entityId": "entity123",
      "type": "STATIC_MEDIA",
      "membershipTier": 2,
      "runningXP": 500,
      "totalXP": 1000,
      "nftTokenId": "token123",
      "name": "NFT Name",
      "title": "NFT Title",
      "description": "NFT Description",
      "image": "https://example.com/nft/image.jpg",
      "animation_url": "https://example.com/nft/animation.mp4",
      "metadataIPFS": "ipfs://metadata123",
      "createdAt": "2023-06-27T12:45:00Z",
      "attributes": [
        {
          "display_type": "boost_percentage",
          "trait_type": "skill",
          "image": "https://example.com/badge/image.png",
          "item_type": "badge",
          "value": {
            "score": 85
          }
        }
      ]
    }
  ]
}

Successful response

Get membership card details for an entity

This endpoint retrieves membership card details for an entity.

get

/entities/{entityId}/mynfts

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

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}/mynfts?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "userId": "user123",
    "entityId": "entity123",
    "type": "STATIC_MEDIA",
    "membershipTier": 2,
    "runningXP": 500,
    "totalXP": 1000,
    "nftTokenId": "token123",
    "name": "NFT Name",
    "title": "NFT Title",
    "description": "NFT Description",
    "image": "https://example.com/nft/image.jpg",
    "animation_url": "https://example.com/nft/animation.mp4",
    "metadataIPFS": "ipfs://metadata123",
    "createdAt": "2023-06-27T12:45:00Z",
    "attributes": [
      {
        "display_type": "boost_percentage",
        "trait_type": "skill",
        "image": "https://example.com/badge/image.png",
        "item_type": "badge",
        "value": {
          "score": 85
        }
      }
    ]
  },
  "entity_data": {
    "id": "entity123",
    "entityURLAlias": "my-entity",
    "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,
    "defaultDyNftThemeId": "0",
    "discordQuestWebhookURL": "https://example.com/discord-webhook",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z",
    "theme": {},
    "parentEntityId": "e-0000001",
    "chainSource": "OFF_CHAIN",
    "plan": "FREE",
    "entityRecordIds": [
      "record1",
      "record2"
    ],
    "contracts": [
      "contract1",
      "contract2"
    ]
  }
}

Successful response

Recalculate users membership card

This endpoint recalculates a user's membership card.

get

/hidden/entities/{entityId}/recalculate-mynft

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

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/hidden/entities/{entityId}/recalculate-mynft?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true
}

Successful response

Get all membership card themes for an entity

This endpoint retrieves all the membership card themes for an entity.

get

/entities/{entityId}/themes

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

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}/themes?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": [
    {
      "themeId": "theme123",
      "entityId": "entity123",
      "membershipTier": 2,
      "tokenId": "token123",
      "price": "0.1 ETH",
      "title": "Theme Title",
      "backgroundImage": "https://example.com/theme/background.jpg",
      "squareLogoImage": "https://example.com/theme/logo-square.png",
      "horizontalLogoImage": "https://example.com/theme/logo-horizontal.png",
      "backgroundColor": "#FFFFFF",
      "accentColor1": "#FF0000",
      "accentColor2": "#00FF00",
      "metadataIPFS": "ipfs://metadata123",
      "createdAt": "2023-06-27T12:45:00Z",
      "attributes": [
        {
          "display_type": "boost_percentage",
          "trait_type": "skill",
          "value": {
            "score": 85
          }
        }
      ]
    }
  ]
}

Successful response

Add new theme for an entity

This endpoint allows to add a new theme for an entity.

post

/entities/{entityId}/themes

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

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

membershipTiernumberrequired

Example: 10

titlestringrequired

Example: dummy-title

pricestringrequired

Example: 100 $

backgroundImageIPFSstring

Example: image-ipfs

horizontalLogoImageIPFSstring

Example: image-ipfs

squareLogoImageIPFSstring

Example: image-ipfs

backgroundColorstring

Example: red

accentColor1string

Example: red

accentColor2string

Example: red

metadataIPFSstring

Example: ipfs

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/themes?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "membershipTier": 10,
    "title": "dummy-title",
    "price": "100 $",
    "backgroundImageIPFS": "image-ipfs",
    "horizontalLogoImageIPFS": "image-ipfs",
    "squareLogoImageIPFS": "image-ipfs",
    "backgroundColor": "red",
    "accentColor1": "red",
    "accentColor2": "red",
    "metadataIPFS": "ipfs"
  }'

200

400

500

{
  "success": true,
  "themeId": "theme-101"
}

Successful response

Get membership card themes details for an entity

This endpoint retrieves the membership card themes details for an entity.

get

/entities/{entityId}/themes/{themeId}

Path parameters

entityIdstringrequired

themeIdstringrequired

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}/themes/{themeId}' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "themeId": "theme123",
    "entityId": "entity123",
    "membershipTier": 2,
    "tokenId": "token123",
    "price": "0.1 ETH",
    "title": "Theme Title",
    "backgroundImage": "https://example.com/theme/background.jpg",
    "squareLogoImage": "https://example.com/theme/logo-square.png",
    "horizontalLogoImage": "https://example.com/theme/logo-horizontal.png",
    "backgroundColor": "#FFFFFF",
    "accentColor1": "#FF0000",
    "accentColor2": "#00FF00",
    "metadataIPFS": "ipfs://metadata123",
    "createdAt": "2023-06-27T12:45:00Z",
    "attributes": [
      {
        "display_type": "boost_percentage",
        "trait_type": "skill",
        "value": {
          "score": 85
        }
      }
    ]
  }
}

Successful response

Update theme for an entity

This endpoint allows to update a new theme for an entity.

post

/entities/{entityId}/themes/{themeId}/update

Path parameters

entityIdstringrequired

themeIdstringrequired

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

membershipTiernumberrequired

Example: 10

titlestringrequired

Example: dummy-title

pricestringrequired

Example: 100 $

backgroundImageIPFSstringrequired

Example: image-ipfs

horizontalLogoImageIPFSstringrequired

Example: image-ipfs

squareLogoImageIPFSstringrequired

Example: image-ipfs

backgroundColorstring

Example: red

accentColor1string

Example: red

accentColor2string

Example: red

metadataIPFSstring

Example: ipfs

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/themes/{themeId}/update?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "membershipTier": 10,
    "title": "dummy-title",
    "price": "100 $",
    "backgroundImageIPFS": "image-ipfs",
    "horizontalLogoImageIPFS": "image-ipfs",
    "squareLogoImageIPFS": "image-ipfs",
    "backgroundColor": "red",
    "accentColor1": "red",
    "accentColor2": "red",
    "metadataIPFS": "ipfs"
  }'

200

400

500

{
  "success": true
}

Successful response

Delete theme for an entity

This endpoint allows to delete a theme for an entity.

post

/entities/{entityId}/themes/{themeId}/delete

Path parameters

entityIdstringrequired

themeIdstringrequired

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

object

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

{
  "success": true
}

Successful response

set default theme for an entity

This endpoint allows to set a default theme for an entity.

post

/entities/{entityId}/themes/default

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

Body

themeIdstringrequired

Example: theme-101

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

{
  "success": true
}

Successful response

Get XP for a specific entity

Retrieve the XP (experience points) for a specific entity.

get

/entities/{entityId}/xp

Path parameters

entityIdstringrequired

ID of the entity to get XP for

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}/xp?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

404

500

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

Successful response

Get XP for multiple entities

Retrieve the XP (experience points) for multiple entities.

post

/entities/xp

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

entityIdsstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/xp?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "entityIds": [
      "text"
    ]
  }'

200

400

401

404

500

{
  "success": true,
  "data": [
    {
      "entityId": "entity123",
      "runningXP": 500
    }
  ]
}

Successful response

Get XP history for a user in a specific entity

Retrieve the XP history for a specific user in a specific entity.

get

/entities/{entityId}/users/{userId}/xp-history

Path parameters

entityIdstringrequired

The ID of the entity.

userIdstringrequired

The ID of the user.

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

pageinteger · default: 1

The page number for pagination (default: 1).

limitinteger · default: 20

The number of items per page (default: 20).

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}/users/{userId}/xp-history?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

401

500

{
  "success": true,
  "page": 1,
  "totalCount": 50,
  "totalPages": 3,
  "data": [
    {
      "userId": "user123",
      "entityId": "entity456",
      "xp": 500,
      "title": "XP Gain",
      "createdAt": "2023-01-01T12:00:00Z"
    }
  ]
}

Successful response

Get XP leaderboard for a specific entity

Retrieve the XP leaderboard for a specific entity, showing users with the highest XP.

get

/entities/{entityId}/xp-leaderboard

Path parameters

entityIdstringrequired

The ID of the entity.

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

pageinteger · default: 1

The page number for pagination (default: 1).

limitinteger · default: 20

The number of items per page (default: 20).

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}/xp-leaderboard?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

401

500

{
  "success": true,
  "page": 1,
  "totalCount": 50,
  "totalPages": 3,
  "data": [
    {
      "userId": "user123",
      "imageUrl": "https://example.com/user123.jpg",
      "name": "John Doe",
      "runningXP": 500
    }
  ]
}

Successful response

Get user XP leaderboard rank

Retrieve the XP leaderboard rank for a specific user in a given entity. The response includes the user's position, threshold information, and whether the user is within the specified threshold.

get

/entities/{entityId}/users/{userId}/xp-leaderboard-rank

Path parameters

entityIdstringrequired

The ID of the entity

userIdstringrequired

The ID of the user

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

thresholdinteger · max: 100

The percentage threshold for XP

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}/users/{userId}/xp-leaderboard-rank?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "position": 1,
    "threshold": "5%",
    "isUserInThreshold": true
  }
}

Successful response

Get all tags an entity

This endpoint retrieves all the tags of an entity.

get

/entities/{entityId}/tags

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

{
  "success": true,
  "data": {
    "tagId": "tag-121",
    "tagName": "super-tag",
    "description": "This is our tag",
    "isPrivate": false,
    "tagUsers": [
      "user-11",
      "user-33"
    ]
  }
}

Successful response