Entity

Create new entity

This endpoint creates a new entity.

post

/entities

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

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

namestringrequired

Example: dummy-entity

chainSourcestringrequired

Example: OFF_CHAIN

contractsstring

Example: dummy-contract

openseaSlugstring

Example: dummy-slug

descriptionstring

Example: description

websitestring

Example: https://www.websitelink.com

imageUrlstring

Example: imageurl

bannerUrlstring

Example: bannerurl

entityURLAliasstring

Example: simple-alias

parentEntityIdstring

Example: e-0000000000

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "dummy-entity",
    "chainSource": "OFF_CHAIN",
    "contracts": "dummy-contract",
    "openseaSlug": "dummy-slug",
    "description": "description",
    "website": "https://www.websitelink.com",
    "imageUrl": "imageurl",
    "bannerUrl": "bannerurl",
    "entityURLAlias": "simple-alias",
    "parentEntityId": "e-0000000000"
  }'

201

400

500

201

{
  "success": true,
  "entityId": "e-000001"
}

Entity created

Get all entities

This endpoint retrieves all the available entities.

get

/entities

Query parameters

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities' \
  --header 'apikey: test'

200

500

200

{
  "success": true,
  "data": [
    {
      "id": "entity123",
      "entityURLAlias": "my-entity",
      "badgeContractAddress": "0x123abc",
      "dyNFTContractAddress": "0x456def",
      "themeContractAddress": "0x789ghi",
      "name": "My Entity",
      "openseaSlug": "my-entity-slug",
      "description": "This is my entity description.",
      "twitter": "myentity",
      "discord": "myentity#1234",
      "telegram": "myentity",
      "instagram": "myentity",
      "website": "https://myentity.com",
      "medium": "myentity",
      "imageUrl": "https://example.com/myentity.jpg",
      "bannerUrl": "https://example.com/myentity-banner.jpg",
      "isEnabled": false,
      "isPrivate": false,
      "defaultDyNftThemeId": "0",
      "discordQuestWebhookURL": "https://example.com/discord-webhook",
      "modifiedAt": "2023-06-27T12:45:00Z",
      "createdAt": "2023-06-25T09:00:00Z",
      "theme": {},
      "parentEntityId": "e-0000001",
      "chainSource": "OFF_CHAIN",
      "plan": "FREE",
      "entityRecordIds": [
        "record1",
        "record2"
      ],
      "contracts": [
        "contract1",
        "contract2"
      ]
    }
  ]
}

Successful response

Get entity details

This endpoint retrieves details of an entity.

get

/entities/{entityId}

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}' \
  --header 'apikey: test'

200

500

200

{
  "success": true,
  "data": {
    "id": "entity123",
    "entityURLAlias": "my-entity",
    "badgeContractAddress": "0x123abc",
    "dyNFTContractAddress": "0x456def",
    "themeContractAddress": "0x789ghi",
    "name": "My Entity",
    "openseaSlug": "my-entity-slug",
    "description": "This is my entity description.",
    "twitter": "myentity",
    "discord": "myentity#1234",
    "telegram": "myentity",
    "instagram": "myentity",
    "website": "https://myentity.com",
    "medium": "myentity",
    "imageUrl": "https://example.com/myentity.jpg",
    "bannerUrl": "https://example.com/myentity-banner.jpg",
    "isEnabled": false,
    "isPrivate": false,
    "defaultDyNftThemeId": "0",
    "discordQuestWebhookURL": "https://example.com/discord-webhook",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z",
    "theme": {},
    "parentEntityId": "e-0000001",
    "chainSource": "OFF_CHAIN",
    "plan": "FREE",
    "entityRecordIds": [
      "record1",
      "record2"
    ],
    "contracts": [
      "contract1",
      "contract2"
    ]
  }
}

Successful response

Update entity details

This endpoint updates an entity.

post

/entities/{entityId}/update

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

namestring

Example: dummy-entity

descriptionstring

Example: description

twitterstring

Example: twitterid

discordstring

Example: discordId

telegramstring

Example: telegramId

instagramstring

Example: instagramId

websitestring

Example: https://www.websitelink.com

imageUrlstring

Example: imageurl

bannerUrlstring

Example: bannerurl

entityURLAliasstring

Example: simple-alias

isPrivateboolean

Example: true

decreaseCreditsAtstring

Example: CAMPAIGN_CREATION

decreaseCreditsFromstring

Example: SUB_ENTITY

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/update' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "dummy-entity",
    "description": "description",
    "twitter": "twitterid",
    "discord": "discordId",
    "telegram": "telegramId",
    "instagram": "instagramId",
    "website": "https://www.websitelink.com",
    "imageUrl": "imageurl",
    "bannerUrl": "bannerurl",
    "entityURLAlias": "simple-alias",
    "isPrivate": true,
    "decreaseCreditsAt": "CAMPAIGN_CREATION",
    "decreaseCreditsFrom": "SUB_ENTITY"
  }'

200

400

500

200

{
  "success": true
}

Entity updated

Add a custom entity ID

This endpoint adds a new custom entity ID.

post

/entities/{entityId}/custom-ids

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

customPlatformNamestringrequired

Example: dummy-platform

customPlatformIdstringrequired

Example: platformId

namestring

Example: dummy-name

usernamestring

Example: dummy-username

linkstring

Example: dummy-link

accessTokenstring

Example: dummy-access-token

refreshTokenstring

Example: dummy-refresh-token

expiresInstring

Example: some-date

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/custom-ids' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "customPlatformName": "dummy-platform",
    "customPlatformId": "platformId",
    "name": "dummy-name",
    "username": "dummy-username",
    "link": "dummy-link",
    "accessToken": "dummy-access-token",
    "refreshToken": "dummy-refresh-token",
    "expiresIn": "some-date"
  }'

200

400

500

200

{
  "success": true
}

Entity ID added

Get entity ID for alias

This endpoint retrieves the entityId associated with the given alias.

get

/entities/alias/{alias}/id

Path parameters

aliasstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/alias/{alias}/id' \
  --header 'apikey: test'

200

500

200

{
  "success": true,
  "data": "e-00001"
}

Successful response

Get entity ID for custom entity ID

This endpoint retrieves the entityId associated with the given customEntityId.

get

/entities/custom-ids/{customEntityId}/id

Path parameters

customEntityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/custom-ids/{customEntityId}/id' \
  --header 'apikey: test'

200

400

500

200

{
  "success": true,
  "data": "e-00001"
}

Successful response

Update entity Plan

This endpoint updates the entity's current plan.

post

/entities/{entityId}/update-plan

Path parameters

entityIdstringrequired

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

productobjectrequired

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}/update-plan' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "product": {
      "name": "product-name"
    }
  }'

200

400

401

500

200

{
  "success": true
}

Successful response

Get Users of an entity

This endpoint retrieves all the users associated with the given entity.

get

/entities/{entityId}/users

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

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}/users?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

500

200

{
  "success": true,
  "users": {
    "userId": "u-userid",
    "imageUrl": "imageurl",
    "location": "india",
    "name": "name",
    "subtitle": "blazingly fast",
    "createdAt": "2023-06-25T09:00:00Z",
    "xp": 10,
    "level": 1,
    "emails": [
      "[email protected]"
    ],
    "ethAddresses": [
      "0xc0ffee254729296a45a3885639AC7E10F9d54979"
    ],
    "tagDetails": [
      {
        "createdAt": "2023-06-25T09:00:00Z",
        "tagId": "dummyId",
        "tagName": "tagnem",
        "entityId": "entityId",
        "description": "description",
        "isPrivate": true,
        "isEnabled": true,
        "tagUsers": [
          "userId"
        ]
      }
    ]
  }
}

Successful response

Add users to entity

This endpoint adds the users to a given entity.

post

/entities/{entityId}/force-add

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

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

userIdsstring[]required

Example: ["userId"]

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}/force-add?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "userIds": [
      "userId"
    ]
  }'

200

400

401

500

200

{
  "success": true
}

Successful response

Add admin to entity

This endpoint adds an admin to the entity.

post

/entities/{entityId}/invite

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

rolestring

Example: ADMIN

emailstringrequired

Example: [email protected]

namestring

Example: Jon Doe

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/invite' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "role": "ADMIN",
    "email": "[email protected]",
    "name": "Jon Doe"
  }'

200

400

500

200

{
  "success": true,
  "message": "Admin added to entity"
}

Successful response

Get entity API keys

This endpoint retrives the API key for an entity.

get

/entities/{entityId}/keys

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/keys?userId=dummy-userid'

200

400

500

200

{
  "success": true,
  "data": {
    "key": "dummy-key",
    "secret": "dummy-secret",
    "apiCount": 1,
    "apiThreshold": 10,
    "entityId": "e-00001",
    "createdAt": "12/06/23"
  }
}

Successful response

Get Entity Theme

Retrieve the theme of an entity by its ID.

get

/entities/{id}/get-theme

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{id}/get-theme'

200

400

500

200

{
  "success": true,
  "theme": {
    "accentColor": "text",
    "backgroundColor": "text",
    "fontFamily": "text",
    "layout": "text"
  }
}

Successful response

Update the theme of an entity.

This endpoint allows to update the theme of an entity.

post

/entities/{id}/update-theme

Path parameters

idstringrequired

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

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Body

themeobjectrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{id}/update-theme' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid' \
  --header 'Content-Type: application/json' \
  --data '{
    "theme": {}
  }'

200

401

500

200

{
  "success": true,
  "message": "Entity theme updated successfully"
}

Successful response

Get all admins of an entity.

This endpoint retrieves all the active admins of an entity.

get

/entities/{entityId}/admins

Path parameters

entityIdstringrequired

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

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

500

200

{
  "success": true,
  "data": [
    {
      "userId": "user123",
      "name": "somebody",
      "imageUrl": "https://www.myimage.com",
      "isActive": true,
      "createdAt": "2023-06-25T09:00:00Z",
      "role": "ADMIN",
      "ethAddresses": [
        "0xc0ffee254729296a45a3885639AC7E10F9d54979"
      ],
      "emails": [
        "[email protected]"
      ]
    }
  ]
}

Successful response

Remove admin from an entity.

This endpoint allows the owner to remove an admin from an entity.

post

/entities/{entityId}/remove-admin

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

userIdstringrequired

Example: admin-1

ownerUserIdstringrequired

Example: entity-owner-1

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/remove-admin' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "admin-1",
    "ownerUserId": "entity-owner-1"
  }'

200

400

500

200

{
  "success": true,
  "message": "Admin removed successfully."
}

Successful response.

Approve entity creation

This endpoint enables the creation of an entity.

post

/admin/entities/approve

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

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

entityIdstringrequired

Example: e-00001

baseNamestring

Example: dummy-base-name

baseSymbolstring

Example: dummy-base-symbol

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/admin/entities/approve?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "entityId": "e-00001",
    "baseName": "dummy-base-name",
    "baseSymbol": "dummy-base-symbol"
  }'

200

400

401

500

200

{
  "success": true
}

Successful response

Get all pending entities

This endpoint retrieves all the entities that are yet to be enabled.

get

/admin/entities/pending

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

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

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/admin/entities/pending?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

401

500

200

{
  "success": true,
  "data": [
    {
      "id": "entity123",
      "entityURLAlias": "my-entity",
      "badgeContractAddress": "0x123abc",
      "dyNFTContractAddress": "0x456def",
      "themeContractAddress": "0x789ghi",
      "name": "My Entity",
      "openseaSlug": "my-entity-slug",
      "description": "This is my entity description.",
      "twitter": "myentity",
      "discord": "myentity#1234",
      "telegram": "myentity",
      "instagram": "myentity",
      "website": "https://myentity.com",
      "medium": "myentity",
      "imageUrl": "https://example.com/myentity.jpg",
      "bannerUrl": "https://example.com/myentity-banner.jpg",
      "isEnabled": false,
      "isPrivate": false,
      "defaultDyNftThemeId": "0",
      "discordQuestWebhookURL": "https://example.com/discord-webhook",
      "modifiedAt": "2023-06-27T12:45:00Z",
      "createdAt": "2023-06-25T09:00:00Z",
      "theme": {},
      "parentEntityId": "e-0000001",
      "chainSource": "OFF_CHAIN",
      "plan": "FREE",
      "entityRecordIds": [
        "record1",
        "record2"
      ],
      "contracts": [
        "contract1",
        "contract2"
      ]
    }
  ]
}

Successful response

Connect Twitter

This endpoint connects the twitter account associated with the entity.

post

/entities/{entityId}/connect-twitter

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

userIdstring

Example: u-0000101

entityIdstring

Example: e-0000101

codestring

Example: twitter-redirect-code

redirectUristring

Example: twitter-redirect-uri

typestring

Example: ENTITY_RECORD

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/connect-twitter' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "u-0000101",
    "entityId": "e-0000101",
    "code": "twitter-redirect-code",
    "redirectUri": "twitter-redirect-uri",
    "type": "ENTITY_RECORD"
  }'

200

400

500

200

{
  "success": true,
  "recordId": "twitter-username"
}

Successful response

Remove Twitter

This endpoint disconnects the twitter account associated with the entity.

post

/entities/{entityId}/remove-twitter

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/remove-twitter' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

500

200

{
  "success": true
}

Successful response

Connect Discord

This endpoint connects the discord account associated with the entity.

post

/entities/{entityId}/connect-discord

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

guildIdstring

Example: id123

permissionsnumber

Example: 123

userIdstring

Example: u-0000101

entityIdstring

Example: e-0000101

codestring

Example: twitter-redirect-code

redirectUristring

Example: twitter-redirect-uri

typestring

Example: ENTITY_RECORD

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/connect-discord' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "guildId": "id123",
    "permissions": 123,
    "userId": "u-0000101",
    "entityId": "e-0000101",
    "code": "twitter-redirect-code",
    "redirectUri": "twitter-redirect-uri",
    "type": "ENTITY_RECORD"
  }'

200

400

500

200

{
  "success": true,
  "recordId": "discord-username"
}

Successful response

Remove Discord

This endpoint disconnects the discord account associated with the entity.

post

/entities/{entityId}/remove-discord

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/remove-discord' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

500

200

{
  "success": true
}

Successful response

Get Social Tokens for Entity

Retrieve social tokens for an entity by its ID.

get

/entities/{entityId}/social-tokens

Path parameters

entityIdstringrequired

Query parameters

recordTypestring · enumrequired

Type of social record (e.g., TWITTER, DISCORD, INSTAGRAM)

Options: TWITTER, DISCORD, INSTAGRAM, TELEGRAM, STRIPE, OPENAI, GOOGLE, RAPID_API, SEGMENT, GOOGLE_ANALYTICS, MIXPANEL, AMPLITUDE, HEAP

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

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}/social-tokens?recordType=TWITTER' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

500

200

{
  "success": true,
  "data": {
    "entityId": "123456",
    "recordType": "TWITTER",
    "authClientId": "your_auth_client_id",
    "authorizationToken": "your_authorization_token",
    "apiKey": "your_api_key",
    "apiHost": "api.twitter.com",
    "trackingId": "your_google_analytics_tracking_id"
  }
}

Successful response

Add or Update Social Tokens for User in Entity

Add or update social tokens for a user within an entity.

post

/entities/{entityId}/users/{userId}/social-tokens

Path parameters

entityIdstringrequired

userIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

authClientIdstring

authClientSecretstring

apiKeystring

apiSecretstring

authorizationTokenstring

apiHoststring

recordTypestring · enum

Options: TWITTER, DISCORD, INSTAGRAM, TELEGRAM, STRIPE, OPENAI, GOOGLE, RAPID_API, SEGMENT, GOOGLE_ANALYTICS, MIXPANEL, AMPLITUDE, HEAP

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/social-tokens' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "authClientId": "text",
    "authClientSecret": "text",
    "apiKey": "text",
    "apiSecret": "text",
    "authorizationToken": "text",
    "apiHost": "text",
    "recordType": "TWITTER"
  }'

200

400

500

200

{
  "success": true
}

Successful response

Get Tracking Tokens for Entity

Retrieve tracking tokens for an entity by its ID.

get

/entities/{entityId}/tracking-tokens

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/tracking-tokens' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

500

200

{
  "success": true,
  "data": [
    {
      "recordType": "SEGMENT",
      "entityId": "123456",
      "authClientId": "your_auth_client_id",
      "authorizationToken": "your_authorization_token",
      "apiKey": "your_api_key",
      "apiHost": "api.segment.com"
    }
  ]
}

Successful response

Check Integration Status for Entity

Check integration status for an entity by its ID.

get

/entities/{entityId}/check-tokens

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/check-tokens' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

500

200

{
  "success": true,
  "data": {
    "TWITTER": true,
    "DISCORD": false,
    "SEGMENT": true,
    "AMPLITUDE": false,
    "HEAP": true,
    "MIXPANEL": false,
    "GOOGLE_ANALYTICS": true
  }
}

Successful response

Connect Slack to Entity

This endpoint allows connecting a Slack account to an entity.

post

/entities/{entityId}/connect-slack

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

Body

codestringrequired

redirectUristringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/connect-slack?userId=text' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "text",
    "redirectUri": "text"
  }'

200

500

200

{
  "success": true,
  "recordId": "xyz123"
}

Successful response

Get MAU Count for Entity

Retrieve Monthly Active Users (MAU) count for a specific entity and month

get

/entities/{entityId}/month/{month}/mau-count

Path parameters

entityIdstringrequired

The unique identifier of the entity.

monthstringrequired

The month for which the MAU count is requested (e.g., "2023-01").

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/month/{month}/mau-count'

200

400

500

200

{
  "success": true,
  "data": {
    "monthlyRequestCount": 100,
    "monthlyUserCount": 50,
    "userIds": [
      "user1",
      "user2"
    ]
  }
}

Successful response

Get All Organizations for Entity

Retrieve all organizations associated with a specific entity.

get

/entities/{entityId}/organizations

Path parameters

entityIdstringrequired

The unique identifier of the entity.

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

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

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}/organizations' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

404

500

200

{
  "status": 200,
  "success": true,
  "json": [
    {
      "entityId": "123456",
      "url": "https://example.com",
      "createdAt": "2023-01-01T12:00:00Z",
      "userIds": [
        "user1",
        "user2"
      ]
    }
  ]
}

Successful response

Delete Entity

This endpoint deletes an entity.

post

/entities/{entityId}/delete

Path parameters

entityIdstringrequired

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

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

500

200

{
  "success": true,
  "message": "Entity deleted successfully"
}

Successful response