Membership Tier

Get all membershipTiers for entity

This endpoint retrieves all the membershipTiers of an entity.

get

/entities/{entityId}/membershipTiers

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

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

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

500

200

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

Successful response

Add new membershipTier for entity

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

post

/entities/{entityId}/membershipTiers

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

xPThresholdnumberrequired

Example: 100

membershipTiernumberrequired

Example: 2

imageIPFSstring

Example: ipfs-hash

descriptionstring

Example: description

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/membershipTiers?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "xPThreshold": 100,
    "membershipTier": 2,
    "imageIPFS": "ipfs-hash",
    "description": "description"
  }'

200

400

500

200

{
  "success": true
}

Successful response

Get membershipTier details for entity

This endpoint retrieves the membershipTier details of an entity.

get

/entities/{entityId}/membershipTiers/{membershipTier}

Path parameters

entityIdstringrequired

membershipTierstringrequired

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

500

200

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

Successful response

Update membershipTier for entity

This endpoint allows to update a membershipTier for an entity.

post

/entities/{entityId}/membershipTiers/{membershipTier}/update

Path parameters

entityIdstringrequired

membershipTierstringrequired

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

xPThresholdnumberrequired

Example: 100

imageIPFSstring

Example: ipfs-hash

descriptionstring

Example: description

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/membershipTiers/{membershipTier}/update?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "xPThreshold": 100,
    "imageIPFS": "ipfs-hash",
    "description": "description"
  }'

200

400

500

200

{
  "success": true
}

Successful response

Delete membershipTier for entity

This endpoint allows to delete a membershipTier for an entity.

post

/entities/{entityId}/membershipTiers/{membershipTier}/delete

Path parameters

entityIdstringrequired

membershipTierstringrequired

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

500

200

{
  "success": true
}

Successful response

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.

post

/entities/{entityId}/membershipTiers/{membershipTier}/claim-rewards

Path parameters

entityIdstringrequired

membershipTierstringrequired

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

addToDynamicNFTbooleanrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/membershipTiers/{membershipTier}/claim-rewards?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "addToDynamicNFT": true
  }'

200

400

401

500

200

{
  "success": true
}

Successful response