Entity Tag

Get all tags an entity

get

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

/entities/{entityId}/tags

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

/entities/{entityId}/tags

HTTPcURLJavaScriptPython

GET /api/entities/{entityId}/tags?userId=dummy-userid HTTP/1.1
Host: https:/.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

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

/entities/{entityId}/tags

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

application/json

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

/entities/{entityId}/tags

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/tags?userId=dummy-userid HTTP/1.1
Host: https:/.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

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

application/json

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

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

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/tags/{tagId}/update?userId=dummy-userid HTTP/1.1
Host: https:/.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

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

application/json

objectOptional

Responses

200

Successful response

application/json

400

Client error

application/json

500

Server error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/tags/{tagId}/delete?userId=dummy-userid HTTP/1.1
Host: https:/.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"
  }
}

Get entity tags for a user

get

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

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

HTTPcURLJavaScriptPython

GET /api/entities/{entityId}/users/{forUserId}/tags HTTP/1.1
Host: https:/.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
    }
  ]
}

All entity tag for a user

post

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

application/json

objectOptional

Responses

200

Successful response

application/json

400

Client error

application/json

500

Server error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/users/{forUserId}/tags/{tagId}/add HTTP/1.1
Host: https:/.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

https://api.questprotocol.xyz/apihttps://staging.questprotocol.xyz/api

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

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

application/json

objectOptional

Responses

200

Successful response

application/json

400

Client error

application/json

500

Server error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/entities/{entityId}/users/{forUserId}/tags/{tagId}/remove HTTP/1.1
Host: https:/.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"
  }
}