Entity Tag

Get all tags an entity

This endpoint retrieves all the tags of an entity.

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

Path parameters

entityId*string

Query parameters

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataobject

Request

JavaScriptCurlPython

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

Response

200400500

{
  "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

This endpoint allows to add a tag for an entity.

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

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

tagNamestring

Example: "tag-101"

descriptionstring

Example: "This is our new tag"

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataobject

Request

JavaScriptCurlPython

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

Response

200400500

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

Update tag for an entity

This endpoint allows to update a tag for an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/tags/{tagId}/update

Path parameters

entityId*string

tagId*string

Query parameters

Header parameters

Body

application/json

tagNamestring

Example: "tag-101"

descriptionstring

Example: "This is our new tag"

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataEntityTag (object)

Request

JavaScriptCurlPython

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

Response

200400500

{
  "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

This endpoint allows to delete a tag for an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/tags/{tagId}/delete

Path parameters

entityId*string

tagId*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

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/tags/{tagId}/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,
  "data": {
    "tagId": "tag123",
    "entityId": "entity123",
    "tagName": "Tag Name",
    "description": "Tag description",
    "tagUsers": [
      "user123",
      "user456"
    ],
    "isPrivate": true,
    "isEnabled": false,
    "createdAt": "2023-06-27T12:45:00Z"
  }
}

Get entity tags for a user

This endpoint retrieves all the entity tags for a user.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{forUserId}/tags

Path parameters

entityId*string

forUserId*string

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataarray of object

Request

JavaScriptCurlPython

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

Response

200400500

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

All entity tag for a user

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{forUserId}/tags/{tagId}/add

Path parameters

entityId*string

forUserId*string

tagId*string

Header parameters

Body

application/json

The request body is an empty object.

object

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataEntityTag (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{forUserId}/tags/{tagId}/add', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200400500

{
  "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

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{forUserId}/tags/{tagId}/remove

Path parameters

entityId*string

forUserId*string

tagId*string

Header parameters

Body

application/json

The request body is an empty object.

object

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataEntityTag (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{forUserId}/tags/{tagId}/remove', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200400500

{
  "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"
  }
}