Entity | Quest Protocol

Quest Protocol

Get entity details

get

This endpoint retrieves details of an entity.

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

500

{
  "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": true,
    "isPrivate": true,
    "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",
    "theme": {},
    "parentEntityId": "e-0000001"
  }
}

Successful response

Get entity ID for alias

get

This endpoint retrieves the entityId associated with the given alias.

Path parameters

aliasstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

500

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

Successful response

Get entity ID for custom entity ID

get

This endpoint retrieves the entityId associated with the given customEntityId.

Path parameters

customEntityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Successful response

Get Users of an entity

get

This endpoint retrieves all the users associated with the given 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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Successful response

Get entity API keys

get

This endpoint retrives the API key for an entity.

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

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

get

Retrieve the theme of an entity by its ID.

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Successful response

Get all admins of an entity.

get

This endpoint retrieves all the active admins of an entity.

Path parameters

entityIdstringrequired

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

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

Get all pending entities

get

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

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

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

200

401

500

{
  "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": true,
      "isPrivate": true,
      "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",
      "theme": {},
      "parentEntityId": "e-0000001"
    }
  ]
}

Successful response

Remove Twitter

post

This endpoint disconnects the twitter account associated with the entity.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "success": true
}

Successful response

Remove Discord

post

This endpoint disconnects the discord account associated with the entity.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "success": true
}

Successful response

get

Retrieve social tokens for an entity by its ID.

Path parameters

entityIdstringrequired

Query parameters

recordTypestring · enumrequired

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

Available options:

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Get Tracking Tokens for Entity

get

Retrieve tracking tokens for an entity by its ID.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

get

Check integration status for an entity by its ID.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

Get MAU Count for Entity

get

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

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

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Successful response

Get All Organizations for Entity

get

Retrieve all organizations associated with a specific entity.

Path parameters

entityIdstringrequired

The unique identifier of the entity.

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

Get all entities

get

This endpoint retrieves all the available entities.

Query parameters

pagestringoptional

The page number of expected set of documents.

Example: 1

limitstringoptional

The limit of the number of documents each page.

Example: 10

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstringoptional

The secret key for authentication

Example: test-secret

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

500

{
  "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": true,
      "isPrivate": true,
      "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",
      "theme": {},
      "parentEntityId": "e-0000001"
    }
  ]
}

Successful response

Create new entity

post

This endpoint creates a new entity.

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

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

entity-authentication-tokenstringoptional

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

Example: dummy-token

Body

namestringrequired

Example: dummy-entity

chainSourcestringrequired

Example: OFF_CHAIN

contractsstringoptional

Example: dummy-contract

openseaSlugstringoptional

Example: dummy-slug

descriptionstringoptional

Example: description

websitestringoptional

Example: https://www.websitelink.com

imageUrlstringoptional

Example: imageurl

bannerUrlstringoptional

Example: bannerurl

entityURLAliasstringoptional

Example: simple-alias

parentEntityIdstringoptional

Example: e-0000000000

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Entity created

Update entity details

post

This endpoint updates an entity.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Body

namestringoptional

Example: dummy-entity

descriptionstringoptional

Example: description

twitterstringoptional

Example: twitterid

discordstringoptional

Example: discordId

telegramstringoptional

Example: telegramId

instagramstringoptional

Example: instagramId

websitestringoptional

Example: https://www.websitelink.com

imageUrlstringoptional

Example: imageurl

bannerUrlstringoptional

Example: bannerurl

entityURLAliasstringoptional

Example: simple-alias

isPrivatebooleanoptional

Example: true

decreaseCreditsAtstringoptional

Example: CAMPAIGN_CREATION

decreaseCreditsFromstringoptional

Example: SUB_ENTITY

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "success": true
}

Entity updated

Add a custom entity ID

post

This endpoint adds a new custom entity ID.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Body

customPlatformNamestringrequired

Example: dummy-platform

customPlatformIdstringrequired

Example: platformId

namestringoptional

Example: dummy-name

usernamestringoptional

Example: dummy-username

linkstringoptional

Example: dummy-link

accessTokenstringoptional

Example: dummy-access-token

refreshTokenstringoptional

Example: dummy-refresh-token

expiresInstringoptional

Example: some-date

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "success": true
}

Entity ID added

Update entity Plan

post

This endpoint updates the entity's current plan.

Path parameters

entityIdstringrequired

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

productobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "success": true
}

Successful response

Add users to entity

post

This endpoint adds the users to a given 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

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

cURL

JavaScript

Python

HTTP

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

{
  "success": true
}

Successful response

Add admin to entity

post

This endpoint adds an admin to the entity.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Body

rolestringoptional

Example: ADMIN

emailstringrequired

Example: [email protected]

namestringoptional

Example: Jon Doe

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

Update the theme of an entity.

post

This endpoint allows to update the theme of an entity.

Path parameters

idstringrequired

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

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Body

themeobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

Remove admin from an entity.

post

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

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

cURL

JavaScript

Python

HTTP

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

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

Successful response.

Approve entity creation

post

This endpoint enables the creation of an entity.

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

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

baseNamestringoptional

Example: dummy-base-name

baseSymbolstringoptional

Example: dummy-base-symbol

Responses

application/json

cURL

JavaScript

Python

HTTP

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

{
  "success": true
}

Successful response

Connect Twitter

post

This endpoint connects the twitter account associated with the entity.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Body

userIdstringoptional

Example: u-0000101

entityIdstringoptional

Example: e-0000101

codestringoptional

Example: twitter-redirect-code

redirectUristringoptional

Example: twitter-redirect-uri

typestringoptional

Example: ENTITY_RECORD

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

Connect Discord

post

This endpoint connects the discord account associated with the entity.

Path parameters

entityIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Body

guildIdstringoptional

Example: id123

permissionsnumberoptional

Example: 123

userIdstringoptional

Example: u-0000101

entityIdstringoptional

Example: e-0000101

codestringoptional

Example: twitter-redirect-code

redirectUristringoptional

Example: twitter-redirect-uri

typestringoptional

Example: ENTITY_RECORD

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

post

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

Path parameters

entityIdstringrequired

userIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Body

authClientIdstringoptional

authClientSecretstringoptional

apiKeystringoptional

apiSecretstringoptional

recordTypestring · enumoptional

Available options:

authorizationTokenstringoptional

apiHoststringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
    "recordType": "TWITTER",
    "authorizationToken": "text",
    "apiHost": "text"
  }'

200

400

500

{
  "success": true
}

Successful response

Connect Slack to Entity

post

This endpoint allows connecting a Slack account to an entity.

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

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

entity-authentication-tokenstringoptional

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

Example: dummy-token

Body

codestringrequired

redirectUristringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

Delete Entity

post

This endpoint deletes an entity.

Path parameters

entityIdstringrequired

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

objectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful response

Get entity details

Get entity ID for alias

Get entity ID for custom entity ID

Get Users of an entity

Get entity API keys

Get Entity Theme

Get all admins of an entity.

Get all pending entities

Remove Twitter

Remove Discord

Get Social Tokens for Entity

Get Tracking Tokens for Entity

Check Integration Status for Entity

Get MAU Count for Entity

Get All Organizations for Entity

Get all entities

Create new entity

Update entity details

Add a custom entity ID

Update entity Plan

Show child attributes

Add users to entity

Add admin to entity

Update the theme of an entity.

Remove admin from an entity.

Approve entity creation

Connect Twitter

Connect Discord

Add or Update Social Tokens for User in Entity

Connect Slack to Entity

Delete Entity