Membership Tier

Get all membershipTiers for entity

This endpoint retrieves all the membershipTiers of an entity.

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

Path parameters

entityId*string

Query parameters

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataarray of MembershipTier (object)

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": true,
  "data": [
    {
      "entityId": "entity123",
      "membershipTier": 1,
      "xpThreshold": 1000,
      "isEnabled": true,
      "createdAt": "2023-06-27T12:45:00Z",
      "description": "Membership tier description",
      "imageIPFS": "ipfs://image123"
    }
  ]
}

Add new membershipTier for entity

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

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

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

xPThreshold*number

Example: 100

membershipTier*number

Example: 2

imageIPFSstring

Example: "ipfs-hash"

descriptionstring

Example: "description"

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": true
}

Get membershipTier details for entity

This endpoint retrieves the membershipTier details of an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/membershipTiers/{membershipTier}

Path parameters

entityId*string

membershipTier*string

Query parameters

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataMembershipTier (object)

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "membershipTier": 1,
    "xpThreshold": 1000,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z",
    "description": "Membership tier description",
    "imageIPFS": "ipfs://image123"
  }
}

Update membershipTier for entity

This endpoint allows to update a membershipTier for an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/membershipTiers/{membershipTier}/update

Path parameters

entityId*string

membershipTier*string

Query parameters

Header parameters

Body

application/json

xPThreshold*number

Example: 100

imageIPFSstring

Example: "ipfs-hash"

descriptionstring

Example: "description"

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": true
}

Delete membershipTier for entity

This endpoint allows to delete a membershipTier for an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/membershipTiers/{membershipTier}/delete

Path parameters

entityId*string

membershipTier*string

Query parameters

Header parameters

Body

application/json

The request body is an empty object.

object

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": true
}

Claim rewards for a specific membership tier of an entity

This endpoint allows users to claim rewards for a specific membership tier of an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/membershipTiers/{membershipTier}/claim-rewards

Path parameters

entityId*string

membershipTier*string

Query parameters

Header parameters

Body

application/json

addToDynamicNFT*boolean

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400401500

{
  "success": true
}