Entity
This endpoint creates a new entity.
The Id of the user performing the request.
dummy-useridThe API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokendummy-entityOFF_CHAINdummy-contractdummy-slugdescriptionhttps://www.websitelink.comimageurlbannerurlsimple-aliase-0000000000Entity created
Client error
Server error
POST /api/entities?userId=dummy-userid HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 283
{
"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"
}{
"success": true,
"entityId": "e-000001"
}This endpoint retrieves all the available entities.
The page number of expected set of documents.
1The limit of the number of documents each page.
10The API key for authentication
testThe secret key for authentication
test-secretSuccessful response
Server error
GET /api/entities HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
Accept: */*
{
"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",
"theme": {},
"parentEntityId": "e-0000001"
}
]
}This endpoint retrieves details of an entity.
The API key for authentication
testThe secret key for authentication
test-secretSuccessful response
Server error
GET /api/entities/{entityId} HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
Accept: */*
{
"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",
"theme": {},
"parentEntityId": "e-0000001"
}
}This endpoint updates an entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokendummy-entitydescriptiontwitteriddiscordIdtelegramIdinstagramIdhttps://www.websitelink.comimageurlbannerurlsimple-aliastrueCAMPAIGN_CREATIONSUB_ENTITYEntity updated
Client error
Server error
POST /api/entities/{entityId}/update HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 355
{
"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"
}{
"success": true
}This endpoint adds a new custom entity ID.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokendummy-platformplatformIddummy-namedummy-usernamedummy-linkdummy-access-tokendummy-refresh-tokensome-dateEntity ID added
Client error
Server error
POST /api/entities/{entityId}/custom-ids HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 235
{
"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"
}{
"success": true
}This endpoint retrieves the entityId associated with the given alias.
The API key for authentication
testThe secret key for authentication
test-secretSuccessful response
Server error
GET /api/entities/alias/{alias}/id HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
Accept: */*
{
"success": true,
"data": "e-00001"
}This endpoint retrieves the entityId associated with the given customEntityId.
The API key for authentication
testThe secret key for authentication
test-secretSuccessful response
Client error
Server error
GET /api/entities/custom-ids/{customEntityId}/id HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
Accept: */*
{
"success": true,
"data": "e-00001"
}This endpoint updates the entity's current plan.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenSuccessful response
Client error
Unauthorized error
Server error
POST /api/entities/{entityId}/update-plan HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"product": {
"name": "product-name"
}
}{
"success": true
}This endpoint retrieves all the users associated with the given entity.
The Id of the user performing the request.
dummy-useridThe API key for authentication
testThe secret key for authentication
test-secretThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Client error
Server error
GET /api/entities/{entityId}/users?userId=dummy-userid HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"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
}
}This endpoint adds the users to a given entity.
The Id of the user performing the request.
dummy-useridThe API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-token["userId"]Successful response
Client error
Unauthorized error
Server error
POST /api/entities/{entityId}/force-add?userId=dummy-userid HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"userIds": [
"userId"
]
}{
"success": true
}This endpoint adds an admin to the entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenADMIN[email protected]Jon DoeSuccessful response
Client error
Server error
POST /api/entities/{entityId}/invite HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"role": "ADMIN",
"email": "[email protected]",
"name": "Jon Doe"
}{
"success": true,
"message": "Admin added to entity"
}This endpoint retrives the API key for an entity.
The Id of the user performing the request.
dummy-useridSuccessful response
Client error
Server error
GET /api/entities/{entityId}/keys?userId=dummy-userid HTTP/1.1
Host: https:/.questprotocol.xyz
Accept: */*
{
"success": true,
"data": {
"key": "dummy-key",
"secret": "dummy-secret",
"apiCount": 1,
"apiThreshold": 10,
"entityId": "e-00001",
"createdAt": "12/06/23"
}
}Retrieve the theme of an entity by its ID.
Successful response
Entity not found
Server error
GET /api/entities/{id}/get-theme HTTP/1.1
Host: https:/.questprotocol.xyz
Accept: */*
{
"success": true,
"theme": {
"accentColor": "text",
"backgroundColor": "text",
"fontFamily": "text",
"layout": "text"
}
}This endpoint allows to update the theme of an entity.
The API key for authentication
testThe secret key for authentication
test-secretThe token for user authentication.
dummy-tokenThe Id of the user performing the request.
dummy-useridSuccessful response
Unauthorized error
Server error
POST /api/entities/{id}/update-theme HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
token: dummy-token
userid: dummy-userid
Content-Type: application/json
Accept: */*
Content-Length: 12
{
"theme": {}
}{
"success": true,
"message": "Entity theme updated successfully"
}This endpoint retrieves all the active admins of an entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenSuccessful response
Client error.
Unauthorized error
Server error
GET /api/entities/{entityId}/admins HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"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"
}
]
}This endpoint allows the owner to remove an admin from an entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenadmin-1entity-owner-1Successful response.
Client error.
Server error
POST /api/entities/{entityId}/remove-admin HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"userId": "admin-1",
"ownerUserId": "entity-owner-1"
}{
"success": true,
"message": "Admin removed successfully."
}This endpoint enables the creation of an entity.
The Id of the user performing the request.
dummy-useridThe API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokene-00001dummy-base-namedummy-base-symbolSuccessful response
Successful response
Unauthorized error
Server error
POST /api/admin/entities/approve?userId=dummy-userid HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"entityId": "e-00001",
"baseName": "dummy-base-name",
"baseSymbol": "dummy-base-symbol"
}{
"success": true
}This endpoint retrieves all the entities that are yet to be enabled.
The Id of the user performing the request.
dummy-useridThe API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenSuccessful response
Unauthorized error
Server error
GET /api/admin/entities/pending?userId=dummy-userid HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"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",
"theme": {},
"parentEntityId": "e-0000001"
}
]
}This endpoint connects the twitter account associated with the entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenu-0000101e-0000101twitter-redirect-codetwitter-redirect-uriENTITY_RECORDSuccessful response
Client error
Server error
POST /api/entities/{entityId}/connect-twitter HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 136
{
"userId": "u-0000101",
"entityId": "e-0000101",
"code": "twitter-redirect-code",
"redirectUri": "twitter-redirect-uri",
"type": "ENTITY_RECORD"
}{
"success": true,
"recordId": "twitter-username"
}This endpoint disconnects the twitter account associated with the entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Client error
Server error
POST /api/entities/{entityId}/remove-twitter HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"success": true
}This endpoint connects the discord account associated with the entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenid123123u-0000101e-0000101twitter-redirect-codetwitter-redirect-uriENTITY_RECORDSuccessful response
Client error
Server error
POST /api/entities/{entityId}/connect-discord HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 172
{
"guildId": "id123",
"permissions": 123,
"userId": "u-0000101",
"entityId": "e-0000101",
"code": "twitter-redirect-code",
"redirectUri": "twitter-redirect-uri",
"type": "ENTITY_RECORD"
}{
"success": true,
"recordId": "discord-username"
}This endpoint disconnects the discord account associated with the entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Client error
Server error
POST /api/entities/{entityId}/remove-discord HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"success": true
}Retrieve social tokens for an entity by its ID.
Type of social record (e.g., TWITTER, DISCORD, INSTAGRAM)
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Bad Request
Server error
GET /api/entities/{entityId}/social-tokens?recordType=TWITTER HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"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 a user within an entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Bad Request
Server error
POST /api/entities/{entityId}/users/{userId}/social-tokens HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 152
{
"authClientId": "text",
"authClientSecret": "text",
"apiKey": "text",
"apiSecret": "text",
"recordType": "TWITTER",
"authorizationToken": "text",
"apiHost": "text"
}{
"success": true
}Retrieve tracking tokens for an entity by its ID.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Server error
GET /api/entities/{entityId}/tracking-tokens HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"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 an entity by its ID.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Server error
GET /api/entities/{entityId}/check-tokens HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"success": true,
"data": {
"TWITTER": true,
"DISCORD": false,
"SEGMENT": true,
"AMPLITUDE": false,
"HEAP": true,
"MIXPANEL": false,
"GOOGLE_ANALYTICS": true
}
}This endpoint allows connecting a Slack account to an entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Server error
POST /api/entities/{entityId}/connect-slack?userId=text HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"code": "text",
"redirectUri": "text"
}{
"success": true,
"recordId": "xyz123"
}Retrieve Monthly Active Users (MAU) count for a specific entity and month
The unique identifier of the entity.
The month for which the MAU count is requested (e.g., "2023-01").
Successful response
Bad Request
Server error
GET /api/entities/{entityId}/month/{month}/mau-count HTTP/1.1
Host: https:/.questprotocol.xyz
Accept: */*
{
"success": true,
"data": {
"monthlyRequestCount": 100,
"monthlyUserCount": 50,
"userIds": [
"user1",
"user2"
]
}
}Retrieve all organizations associated with a specific entity.
The unique identifier of the entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenThe authentication token to authorize requests on behalf of an entity.
dummy-tokenSuccessful response
Not Found
Server error
GET /api/entities/{entityId}/organizations HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"status": 200,
"success": true,
"json": [
{
"entityId": "123456",
"url": "https://example.com",
"userIds": [
"user1",
"user2"
],
"createdAt": "2023-01-01T12:00:00Z"
}
]
}This endpoint deletes an entity.
The API key for authentication
testThe secret key for authentication
test-secretThe Id of the user performing the request.
dummy-useridThe token for user authentication.
dummy-tokenSuccessful response
Client error
Unauthorized error
Server error
POST /api/entities/{entityId}/delete HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"success": true,
"message": "Entity deleted successfully"
}Last updated