Entity Tag | Quest Protocol

Quest Protocol

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

Add tag for an entity

This endpoint allows to add a tag for an entity.

post

/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

Body

tagNamestring

Example: tag-101

descriptionstring

Example: This is our new tag

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/tags?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "tagName": "tag-101",
    "description": "This is our new tag"
  }'

200

400

500

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

Successful response

Update tag for an entity

This endpoint allows to update a tag for an entity.

post

/entities/{entityId}/tags/{tagId}/update

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

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

tagNamestring

Example: tag-101

descriptionstring

Example: This is our new tag

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/tags/{tagId}/update?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "tagName": "tag-101",
    "description": "This is our new tag"
  }'

200

400

500

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

Successful response

Delete tag for an entity

This endpoint allows to delete a tag for an entity.

post

/entities/{entityId}/tags/{tagId}/delete

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

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}/tags/{tagId}/delete?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

400

500

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

Successful response

Get entity tags for a user

This endpoint retrieves all the entity tags for a user.

get

/entities/{entityId}/users/{forUserId}/tags

Path parameters

entityIdstringrequired

forUserIdstringrequired

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

200

400

500

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

Successful response

All entity tag for a user

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

post

/entities/{entityId}/users/{forUserId}/tags/{tagId}/add

Path parameters

entityIdstringrequired

forUserIdstringrequired

tagIdstringrequired

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

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{forUserId}/tags/{tagId}/add' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

400

500

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

Successful response

Remove entity tag for a user

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

post

/entities/{entityId}/users/{forUserId}/tags/{tagId}/remove

Path parameters

entityIdstringrequired

forUserIdstringrequired

tagIdstringrequired

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

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{forUserId}/tags/{tagId}/remove' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

400

500

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

Successful response