Quest Protocol
  • Introduction
    • Welcome to Quest Protocol
    • Integrate & Partner with Quest
    • Use Cases
      • Creator Platforms
      • Gaming
      • NFT Marketplaces
      • Social Media DApps
      • DeFi
  • QUEST PLATFORM
    • Creating a Campaign
    • Audience Overview
    • User Profile
    • Discover Page
    • Perk Store
    • Integrations
    • Memberships
    • Segmentation & Targetting
    • AI Insights
  • QUEST PROTOCOL - SDKs & APIs
    • UI SDK Components
      • Embedded XP Points
      • Embedded in-dApp Guides
      • Embedded Web3 Search
      • Embedded Quests
    • Quest SDKs & APIs
      • User
      • Entity
      • Badge
      • Campaign
      • App Metric
      • Membership Card
      • Entity Tag
      • Membership Tier
      • Skill
      • Entity Credit Tier
      • Gem
      • Custom Reward
      • Entity Gem
      • Entity Alert
      • Entity Feature Flag
      • Entity Data contract
      • Entity Authentication Token
      • Event Metric Mapping
    • Data Engine
  • Website
  • Quest Thesis
Powered by GitBook
On this page
  1. QUEST PROTOCOL - SDKs & APIs
  2. Quest SDKs & APIs

Entity Tag

PreviousMembership CardNextMembership Tier

Last updated 1 year ago

Get entity tags for a user

get

This endpoint retrieves all the entity tags for a user.

Path parameters
entityIdstringRequired
forUserIdstringRequired
Header parameters
apikeystringRequired

The API key for authentication

Example: test
apisecretstringOptional

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
200
Successful response
application/json
400
Client error
application/json
500
Server error
application/json
get
GET /api/entities/{entityId}/users/{forUserId}/tags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*

{
  "success": true,
  "data": [
    {
      "tagId": "tag-121",
      "tagName": "super-tag",
      "description": "This is our tag",
      "isPrivate": false
    }
  ]
}
  • GETGet all tags an entity
  • POSTAdd tag for an entity
  • POSTUpdate tag for an entity
  • POSTDelete tag for an entity
  • GETGet entity tags for a user
  • POSTAll entity tag for a user
  • POSTRemove entity tag for a user

Get all tags an entity

get

This endpoint retrieves all the tags of an entity.

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
apisecretstringOptional

The secret key for authentication

Example: test-secret
tokenstringRequired

The token for user authentication.

Example: dummy-token
Responses
200
Successful response
application/json
400
Client error
application/json
500
Server error
application/json
get
GET /api/entities/{entityId}/tags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*

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

Add tag for an entity

post

This endpoint allows to add a tag for an entity.

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
apisecretstringOptional

The secret key for authentication

Example: test-secret
tokenstringRequired

The token for user authentication.

Example: dummy-token
Body
tagNamestringOptionalExample: tag-101
descriptionstringOptionalExample: This is our new tag
Responses
200
Successful response
application/json
400
Client error
application/json
500
Server error
application/json
post
POST /api/entities/{entityId}/tags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "tagName": "tag-101",
  "description": "This is our new tag"
}
{
  "success": true,
  "data": {
    "tagId": "tag-100",
    "entityId": "entity-101",
    "tagName": "tag-101",
    "description": "This is our new tag"
  }
}

Update tag for an entity

post

This endpoint allows to update a tag for an entity.

Path parameters
entityIdstringRequired
tagIdstringRequired
Query parameters
userIdstringRequired

The Id of the user performing the request.

Example: dummy-userid
Header parameters
apikeystringRequired

The API key for authentication

Example: test
apisecretstringOptional

The secret key for authentication

Example: test-secret
tokenstringRequired

The token for user authentication.

Example: dummy-token
Body
tagNamestringOptionalExample: tag-101
descriptionstringOptionalExample: This is our new tag
Responses
200
Successful response
application/json
400
Client error
application/json
500
Server error
application/json
post
POST /api/entities/{entityId}/tags/{tagId}/update HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "tagName": "tag-101",
  "description": "This is our new tag"
}
{
  "success": true,
  "data": {
    "tagId": "tag123",
    "entityId": "entity123",
    "tagName": "Tag Name",
    "description": "Tag description",
    "tagUsers": [
      "user123",
      "user456"
    ],
    "isPrivate": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z"
  }
}

Delete tag for an entity

post

This endpoint allows to delete a tag for an entity.

Path parameters
entityIdstringRequired
tagIdstringRequired
Query parameters
userIdstringRequired

The Id of the user performing the request.

Example: dummy-userid
Header parameters
apikeystringRequired

The API key for authentication

Example: test
apisecretstringOptional

The secret key for authentication

Example: test-secret
tokenstringRequired

The token for user authentication.

Example: dummy-token
Body
objectOptional
Responses
200
Successful response
application/json
400
Client error
application/json
500
Server error
application/json
post
POST /api/entities/{entityId}/tags/{tagId}/delete HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "success": true,
  "data": {
    "tagId": "tag123",
    "entityId": "entity123",
    "tagName": "Tag Name",
    "description": "Tag description",
    "tagUsers": [
      "user123",
      "user456"
    ],
    "isPrivate": true,
    "isEnabled": false,
    "createdAt": "2023-06-27T12:45:00Z"
  }
}

All entity tag for a user

post

This endpoint allows to add an entity tag for a user.

Path parameters
entityIdstringRequired
forUserIdstringRequired
tagIdstringRequired
Header parameters
apikeystringRequired

The API key for authentication

Example: test
apisecretstringOptional

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
objectOptional
Responses
200
Successful response
application/json
400
Client error
application/json
500
Server error
application/json
post
POST /api/entities/{entityId}/users/{forUserId}/tags/{tagId}/add HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "success": true,
  "data": {
    "tagId": "tag123",
    "entityId": "entity123",
    "tagName": "Tag Name",
    "description": "Tag description",
    "tagUsers": [
      "user123",
      "user456"
    ],
    "isPrivate": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z"
  }
}

Remove entity tag for a user

post

This endpoint allows to remove an entity tag for a user.

Path parameters
entityIdstringRequired
forUserIdstringRequired
tagIdstringRequired
Header parameters
apikeystringRequired

The API key for authentication

Example: test
apisecretstringOptional

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
objectOptional
Responses
200
Successful response
application/json
400
Client error
application/json
500
Server error
application/json
post
POST /api/entities/{entityId}/users/{forUserId}/tags/{tagId}/remove HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "success": true,
  "data": {
    "tagId": "tag123",
    "entityId": "entity123",
    "tagName": "Tag Name",
    "description": "Tag description",
    "tagUsers": [
      "user123",
      "user456"
    ],
    "isPrivate": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z"
  }
}