Entity

Create new entity

This endpoint creates a new entity.

POSThttps://api.questprotocol.xyz/api/entities

Query parameters

Header parameters

Body

application/json

The request body.

name*string

Example: "dummy-entity"

chainSource*string

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"

Response

201400500

Entity created

Body

application/json

successboolean

Example: true

entityIdstring

Example: "e-000001"

Request

JavaScriptCurlPython

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

Response

201400500

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

Get all entities

This endpoint retrieves all the available entities.

GEThttps://api.questprotocol.xyz/api/entities

Query parameters

Header parameters

Response

200500

Successful response

Body

application/json

successboolean

Example: true

dataarray of Entity (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities', {
    method: 'GET',
    headers: {
      "apikey": "test"
    },
});
const data = await response.json();

Response

200500

{
  "success": true,
  "data": [
    {
      "id": "entity123",
      "entityURLAlias": "my-entity",
      "entityRecordIds": [
        "record1",
        "record2"
      ],
      "contracts": [
        "contract1",
        "contract2"
      ],
      "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,
      "chainSource": "OFF_CHAIN",
      "defaultDyNftThemeId": "0",
      "discordQuestWebhookURL": "https://example.com/discord-webhook",
      "modifiedAt": "2023-06-27T12:45:00Z",
      "createdAt": "2023-06-25T09:00:00Z",
      "plan": "FREE",
      "parentEntityId": "e-0000001"
    }
  ]
}

Get entity details

This endpoint retrieves details of an entity.

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

Path parameters

entityId*string

Header parameters

Response

200500

Successful response

Body

application/json

successboolean

Example: true

dataEntity (object)

Request

JavaScriptCurlPython

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

Response

200500

{
  "success": true,
  "data": {
    "id": "entity123",
    "entityURLAlias": "my-entity",
    "entityRecordIds": [
      "record1",
      "record2"
    ],
    "contracts": [
      "contract1",
      "contract2"
    ],
    "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,
    "chainSource": "OFF_CHAIN",
    "defaultDyNftThemeId": "0",
    "discordQuestWebhookURL": "https://example.com/discord-webhook",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z",
    "plan": "FREE",
    "parentEntityId": "e-0000001"
  }
}

Update entity details

This endpoint updates an entity.

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

Path parameters

entityId*string

Header parameters

Body

application/json

The request 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"

Response

200400500

Entity updated

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": true
}

Add a custom entity ID

This endpoint adds a new custom entity ID.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/custom-ids

Path parameters

entityId*string

Header parameters

Body

application/json

The request body.

customPlatformName*string

Example: "dummy-platform"

customPlatformId*string

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"

Response

200400500

Entity ID added

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": true
}

Get entity ID for alias

This endpoint retrieves the entityId associated with the given alias.

GEThttps://api.questprotocol.xyz/api/entities/alias/{alias}/id

Path parameters

alias*string

Header parameters

Response

200500

Successful response

Body

application/json

successboolean

Example: true

datastring

Example: "e-00001"

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/alias/{alias}/id', {
    method: 'GET',
    headers: {
      "apikey": "test"
    },
});
const data = await response.json();

Response

200500

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

Get entity ID for custom entity ID

This endpoint retrieves the entityId associated with the given customEntityId.

GEThttps://api.questprotocol.xyz/api/entities/custom-ids/{customEntityId}/id

Path parameters

customEntityId*string

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

datastring

Example: "e-00001"

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/custom-ids/{customEntityId}/id', {
    method: 'GET',
    headers: {
      "apikey": "test"
    },
});
const data = await response.json();

Response

200400500

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

Update entity Plan

This endpoint updates the entity's current plan.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/update-plan

Path parameters

entityId*string

Header parameters

Body

application/json

product*object

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400401500

{
  "success": true
}

Get Users of an entity

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

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

Path parameters

entityId*string

Query parameters

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

usersobject

Request

JavaScriptCurlPython

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

Response

200400500

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

Add users to entity

This endpoint adds the users to a given entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/force-add

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

userIds*array of string

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400401500

{
  "success": true
}

Add admin to entity

This endpoint adds an admin to the entity.

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

Path parameters

entityId*string

Header parameters

Body

application/json

rolestring

Example: "ADMIN"

email*string

Example: "[email protected]"

namestring

Example: "Jon Doe"

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

messagestring

Example: "Admin added to entity"

Request

JavaScriptCurlPython

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

Response

200400500

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

Get entity API keys

This endpoint retrives the API key for an entity.

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

Path parameters

entityId*string

Query 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}/keys?userId=dummy-userid', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

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

Get Entity Theme

Retrieve the theme of an entity by its ID.

GEThttps://api.questprotocol.xyz/api/entities/{id}/get-theme

Path parameters

id*string

Response

200400500

Successful response

Body

application/json

successboolean

Indicates whether the operation was successful

themeobject

Entity theme object

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{id}/get-theme', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

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

Update the theme of an entity.

This endpoint allows to update the theme of an entity.

POSThttps://api.questprotocol.xyz/api/entities/{id}/update-theme

Path parameters

id*string

Header parameters

Body

application/json

theme*object

Response

200401500

Successful response

Body

application/json

successboolean

Example: true

messagestring

Example: "Entity theme updated successfully"

Request

JavaScriptCurlPython

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

Response

200401500

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

Get all admins of an entity.

This endpoint retrieves all the active admins of an entity.

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

Path parameters

entityId*string

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataarray of object

Request

JavaScriptCurlPython

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

Response

200400401500

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

Remove admin from an entity.

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/remove-admin

Path parameters

entityId*string

Header parameters

Body

application/json

userId*string

Example: "admin-1"

ownerUserId*string

Example: "entity-owner-1"

Response

200400500

Successful response.

Body

application/json

successboolean

Example: true

messagestring

Example: "Admin removed successfully."

Request

JavaScriptCurlPython

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

Response

200400500

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

Approve entity creation

This endpoint enables the creation of an entity.

POSThttps://api.questprotocol.xyz/api/admin/entities/approve

Query parameters

Header parameters

Body

application/json

entityId*string

Example: "e-00001"

baseNamestring

Example: "dummy-base-name"

baseSymbolstring

Example: "dummy-base-symbol"

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400401500

{
  "success": true
}

Get all pending entities

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

GEThttps://api.questprotocol.xyz/api/admin/entities/pending

Query parameters

Header parameters

Response

200401500

Successful response

Body

application/json

successboolean

dataarray of Entity (object)

Request

JavaScriptCurlPython

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

Response

200401500

{
  "success": false,
  "data": [
    {
      "id": "entity123",
      "entityURLAlias": "my-entity",
      "entityRecordIds": [
        "record1",
        "record2"
      ],
      "contracts": [
        "contract1",
        "contract2"
      ],
      "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,
      "chainSource": "OFF_CHAIN",
      "defaultDyNftThemeId": "0",
      "discordQuestWebhookURL": "https://example.com/discord-webhook",
      "modifiedAt": "2023-06-27T12:45:00Z",
      "createdAt": "2023-06-25T09:00:00Z",
      "plan": "FREE",
      "parentEntityId": "e-0000001"
    }
  ]
}

Connect Twitter

This endpoint connects the twitter account associated with the entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/connect-twitter

Path parameters

entityId*string

Header parameters

Body

application/json

userIdstring

Example: "u-0000101"

entityIdstring

Example: "e-0000101"

codestring

Example: "twitter-redirect-code"

redirectUristring

Example: "twitter-redirect-uri"

typestring

Example: "ENTITY_RECORD"

Response

200400500

Successful response

Body

application/json

successboolean

recordIdstring

Example: "twitter-username"

Request

JavaScriptCurlPython

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

Response

200400500

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

Remove Twitter

This endpoint disconnects the twitter account associated with the entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/remove-twitter

Path parameters

entityId*string

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": false
}

Connect Discord

This endpoint connects the discord account associated with the entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/connect-discord

Path parameters

entityId*string

Header parameters

Body

application/json

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"

Response

200400500

Successful response

Body

application/json

successboolean

recordIdstring

Example: "discord-username"

Request

JavaScriptCurlPython

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

Response

200400500

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

Remove Discord

This endpoint disconnects the discord account associated with the entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/remove-discord

Path parameters

entityId*string

Header parameters

Response

200400500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": false
}

Get Social Tokens for Entity

Retrieve social tokens for an entity by its ID.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/social-tokens

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}/social-tokens?recordType=TWITTER', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

200400500

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

Add or Update Social Tokens for User in Entity

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/social-tokens

Path parameters

entityId*string

userId*string

Header parameters

Body

application/json

authClientIdstring

authClientSecretstring

apiKeystring

apiSecretstring

recordTypeenum

TWITTERDISCORDINSTAGRAMTELEGRAMSTRIPEOPENAIGOOGLERAPID_APISEGMENTGOOGLE_ANALYTICSMIXPANELAMPLITUDEHEAP

authorizationTokenstring

apiHoststring

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

Request

JavaScriptCurlPython

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

Response

200400500

{
  "success": true
}

Get Tracking Tokens for Entity

Retrieve tracking tokens for an entity by its ID.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/tracking-tokens

Path parameters

entityId*string

Header parameters

Response

200500

Successful response

Body

application/json

successboolean

Example: true

dataarray of object

Request

JavaScriptCurlPython

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

Response

200500

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

Check Integration Status for Entity

Check integration status for an entity by its ID.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/check-tokens

Path parameters

entityId*string

Header parameters

Response

200500

Successful response

Body

application/json

successboolean

Example: true

dataobject

Request

JavaScriptCurlPython

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

Response

200500

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

Connect Slack to Entity

This endpoint allows connecting a Slack account to an entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/connect-slack

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

code*string

redirectUri*string

Response

200500

Successful response

Body

application/json

successboolean

Example: true

recordIdstring

Example: "xyz123"

Request

JavaScriptCurlPython

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

Response

200500

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

Get MAU Count for Entity

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

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/month/{month}/mau-count

Path parameters

entityId*string

The unique identifier of the entity.

month*string

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

Response

200400500

Successful response

Body

application/json

successboolean

Example: true

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/month/{month}/mau-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

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

Get All Organizations for Entity

Retrieve all organizations associated with a specific entity.

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

Path parameters

entityId*string

The unique identifier of the entity.

Header parameters

Response

200404500

Successful response

Body

application/json

statusnumber

Example: 200

successboolean

Example: true

jsonarray of object

Request

JavaScriptCurlPython

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

Response

200404500

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

Delete Entity

This endpoint deletes an entity.

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

Path parameters

entityId*string

Header parameters

Body

application/json

The request body is an empty object

object

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

messagestring

Example: "Entity deleted successfully"

Request

JavaScriptCurlPython

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

Response

200400401500

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