CollabLand API Server (0.81.3)
Download OpenAPI specification:Download
OAuth2Controller.introspect
Authorizations:
Request Body schema: application/x-www-form-urlencoded
Access Token Request
| token required | string |
| token_type_hint | string Enum: "access_token" "refresh_token" |
Responses
Response samples
- 200
{- "active": true,
- "scope": "string",
- "client_id": "string",
- "username": "string",
- "token_type": "string",
- "exp": 0,
- "iat": 0,
- "nbf": 0,
- "sub": "string",
- "aud": "string",
- "iss": "string",
- "jti": "string"
}OAuth2Controller.token
Authorizations:
Request Body schema: application/x-www-form-urlencoded
Access Token Request
| scope | string |
| client_id | string |
| client_secret | string |
| grant_type required | string Value: "authorization_code" |
| code required | string |
| code_verifier | string |
| redirect_uri required | string |
Responses
Response samples
- 200
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "scope": "string",
- "refresh_token": "string",
- "id_token": "string"
}AccessControlController.getCheckRolesResponse
Authorizations:
path Parameters
| requestId required | string |
Responses
Response samples
- 200
{- "requestId": "string",
- "roles": [
- {
- "id": "string",
- "granted": true
}
], - "errors": [
- {
- "_dummyFieldForGraphQL": "string"
}
]
}AccessControlController.checkRoles
Authorizations:
Request Body schema: application/json
| account | string Wallet address or account id |
Array of objects (TokenGrantedRole) A list of token granted roles to be enforced | |
| callbackUrl | string Webhook url to be invoked once the access is checked |
| async | boolean A flag to control if the response will be sent back asynchronously either via callback or polling |
Responses
Request samples
- Payload
{- "account": "string",
- "rules": [
- {
- "id": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
], - "callbackUrl": "string",
- "async": true
}Response samples
- 200
{- "requestId": "string",
- "roles": [
- {
- "id": "string",
- "granted": true
}
], - "errors": [
- {
- "_dummyFieldForGraphQL": "string"
}
]
}AccessControlController.getRoles
Authorizations:
path Parameters
| communityId required | string |
| userId required | string |
Responses
Response samples
- 200
{- "requestId": "string",
- "roles": [
- {
- "id": "string",
- "granted": true
}
], - "errors": [
- {
- "_dummyFieldForGraphQL": "string"
}
]
}AccountController.getAdministratedCommunities
Authorizations:
query Parameters
| reload | boolean |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "status": "string",
- "communityId": "string",
- "ownerId": "string",
- "adminUserId": "string",
- "platform": "string",
- "link": "string",
- "serverImage": "string",
- "welcomeMessage": "string",
- "network": "string",
- "cashtag": "string",
- "tokenAddress": "string",
- "admins": [
- "string"
], - "activePlans": [
- "string"
], - "iconURL": "string",
- "inviteLink": "string",
- "channels": [
- {
- "name": "string",
- "link": "string",
- "tokenAmountToEnter": 0,
- "members": 0,
- "membersInLastDay": 0,
- "membersDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0
}
], - "quests": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string",
- "stripePaymentIntent": "string",
- "published": true
}
], - "drops": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "chainId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string"
}
], - "stats": {
- "tokenPriceUsd": 0,
- "memberCount": 0,
- "cashtagTweetsInLastDay": 0,
- "cashtagTweetsDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0,
- "myMessageCount": 0,
- "gripStrength": 0,
- "cashtagTweetsPlusMessagesPerDay": 0,
- "dailyVolume": 0
}, - "tpcs": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
], - "disableBkgBalCheck": true,
- "enableAddRoles": true,
- "disablePromotionalUpdates": true,
- "bkgTimestamp": 0,
- "letsGo": 0,
- "memberChecked": 0,
- "memberCount": 0,
- "memberCountInDB": 0,
- "memberCountInGuild": 0,
- "memberIgnored": 0,
- "tgrUpdated": 0,
- "maxAllowedUnits": 0,
- "consumedUnits": 0,
- "unitsLastUpdated": 0
}
]
}AccountController.getUserCommunities
Authorizations:
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "status": "string",
- "communityId": "string",
- "ownerId": "string",
- "adminUserId": "string",
- "platform": "string",
- "link": "string",
- "serverImage": "string",
- "welcomeMessage": "string",
- "network": "string",
- "cashtag": "string",
- "tokenAddress": "string",
- "admins": [
- "string"
], - "activePlans": [
- "string"
], - "iconURL": "string",
- "inviteLink": "string",
- "channels": [
- {
- "name": "string",
- "link": "string",
- "tokenAmountToEnter": 0,
- "members": 0,
- "membersInLastDay": 0,
- "membersDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0
}
], - "quests": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string",
- "stripePaymentIntent": "string",
- "published": true
}
], - "drops": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "chainId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string"
}
], - "stats": {
- "tokenPriceUsd": 0,
- "memberCount": 0,
- "cashtagTweetsInLastDay": 0,
- "cashtagTweetsDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0,
- "myMessageCount": 0,
- "gripStrength": 0,
- "cashtagTweetsPlusMessagesPerDay": 0,
- "dailyVolume": 0
}, - "tpcs": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
], - "disableBkgBalCheck": true,
- "enableAddRoles": true,
- "disablePromotionalUpdates": true,
- "bkgTimestamp": 0,
- "letsGo": 0,
- "memberChecked": 0,
- "memberCount": 0,
- "memberCountInDB": 0,
- "memberCountInGuild": 0,
- "memberIgnored": 0,
- "tgrUpdated": 0,
- "maxAllowedUnits": 0,
- "consumedUnits": 0,
- "unitsLastUpdated": 0
}
]
}AccountController.getUserProfile
Authorizations:
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "platform": "string",
- "userName": "string"
}AccountController.addWalletAddress
Authorizations:
Request Body schema: application/json
| userId required | string The user ID of the account |
| platform required | string Enum: "discord" "telegram" The platform for the account |
Responses
Request samples
- Payload
{- "userId": "string",
- "platform": "discord"
}Response samples
- 200
{- "address": "string",
- "accounts": [
- {
- "cashtag": "string",
- "tokenAddress": "string",
- "chainId": "string",
- "balance": "string"
}
]
}AccountController.getWallets
Authorizations:
query Parameters
| limit | number |
| paginationToken | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "address": "string",
- "signerAddress": "string",
- "contract": "string",
- "accountId": "string",
- "userId": "string",
- "platform": "string",
- "communityId": "string",
- "communityPk": "string",
- "walletType": "string",
- "metadata": {
- "property1": true,
- "property2": true
}
}
]
}BotAccountsController.getSmartAccountAddress
Authorizations:
header Parameters
| X-TG-BOT-TOKEN required | string Your telegram bot token |
Responses
Response samples
- 200
{- "evm": [
- {
- "address": "string",
- "chainId": 0
}
], - "solana": [
- {
- "address": "string",
- "network": "string"
}
], - "pkpAddress": "string"
}BotAccountsController.mintFungibleToken
Authorizations:
query Parameters
| chainId | number |
header Parameters
| X-TG-BOT-TOKEN required | string Your telegram bot token |
Request Body schema: application/json
Request body for the fungible token mint
| name required | string |
| symbol required | string |
| metadata | object |
Responses
Request samples
- Payload
{- "name": "string",
- "symbol": "string",
- "metadata": { }
}Response samples
- 200
{- "response": { }
}BotAccountsController.submitUserOperation
Authorizations:
query Parameters
| chainId | number |
header Parameters
| X-TG-BOT-TOKEN required | string Your telegram bot token |
Request Body schema: application/json
Request body for the user operation
| calldata required | string Calldata for the user operation (in Hex) |
| value required | string Value for the user operation (in Hex) |
| target required | string Target address of user/contract for the user operation |
Responses
Request samples
- Payload
{- "calldata": "string",
- "value": "string",
- "target": "string"
}Response samples
- 200
{- "userOperationHash": "string",
- "chainId": 0
}BotAccountsController.getUserOperationReceipt
Authorizations:
query Parameters
| chainId | number |
| userOperationHash required | string The userOperation hash |
header Parameters
| X-TG-BOT-TOKEN required | string Your telegram bot token |
Responses
Response samples
- 200
{- "userOpHash": "string",
- "entryPoint": "string",
- "sender": "string",
- "nonce": 0,
- "paymaster": "string",
- "actualGasUsed": 0,
- "actualGasCost": 0,
- "success": true,
- "receipt": {
- "transactionHash": "string",
- "transactionIndex": 0,
- "blockHash": "string",
- "blockNumber": 0,
- "from": "string",
- "to": "string",
- "cumulativeGasUsed": 0,
- "status": "string",
- "gasUsed": 0,
- "contractAddress": "string",
- "logsBloom": "string",
- "effectiveGasPrice": 0
}, - "logs": [
- {
- "data": "string",
- "blockNumber": 0,
- "blockHash": "string",
- "transactionHash": "string",
- "logIndex": 0,
- "transactionIndex": 0,
- "address": "string",
- "topics": [
- "string"
]
}
]
}BotAccountsController.executeArbitraryLitAction
Authorizations:
query Parameters
| chainId | number |
header Parameters
| X-TG-BOT-TOKEN required | string Your telegram bot token |
Request Body schema: application/json
Request body for the lit action
| actionIpfs required | string Action IPFS CID |
| actionJsParams required | object Action jsParams data object |
Responses
Request samples
- Payload
{- "actionIpfs": "string",
- "actionJsParams": { }
}Response samples
- 200
{- "response": { }
}BotAccountsController.submitSolanaTransaction
Authorizations:
query Parameters
| network | string |
header Parameters
| X-TG-BOT-TOKEN required | string Your telegram bot token |
Request Body schema: application/json
Request body for the transaction instructions
| serializedTransactionBase64 required | string The serialized transaction, as a base64 encoded string |
Responses
Request samples
- Payload
{- "serializedTransactionBase64": "string"
}Response samples
- 200
{- "txSignature": "string"
}BotAccountsController.getSolanaTransactionReceipt
Authorizations:
query Parameters
| network | string |
| txSignatureBase64 required | string The transaction signature in base64 encoded string |
header Parameters
| X-TG-BOT-TOKEN required | string Your telegram bot token |
Responses
Response samples
- 200
{- "response": { }
}BotAccountsController.calculateAccountAddressBasedOnPlatform
Authorizations:
Request Body schema: application/json
Request body for the platform user ID
| userId required | string Platform user ID |
| platform required | string Platform name |
Responses
Request samples
- Payload
{- "userId": "string",
- "platform": "string"
}Response samples
- 200
{- "evm": [
- {
- "address": "string",
- "chainId": 0
}
], - "solana": [
- {
- "address": "string",
- "network": "string"
}
], - "pkpAddress": "string"
}BotAccountsController.getSmartAccountAddressForPlatformAuth
Authorizations:
query Parameters
| platform required | string Enum: "twitter" "github" "telegram" The platform you want to get the smart account addresses for |
header Parameters
| X-ACCESS-TOKEN required | string Your access token for the platform, could be bot tokens or OAuth2 access tokens |
Responses
Response samples
- 200
{- "evm": [
- {
- "address": "string",
- "chainId": 0
}
], - "solana": [
- {
- "address": "string",
- "network": "string"
}
], - "pkpAddress": "string"
}BotAccountsController.submitUserOperationUsingPlatformAuth
Authorizations:
query Parameters
| chainId | number |
| platform required | string Enum: "telegram" "twitter" "github" Your platform |
header Parameters
| X-ACCESS-TOKEN required | string Your access token for the platform, could be bot tokens or OAuth2 access tokens |
Request Body schema: application/json
Request body for the user operation batch
required | Array of objects (UserOperationRequest) | ||||||
Array
| |||||||
Responses
Request samples
- Payload
{- "userOps": [
- {
- "calldata": "string",
- "value": "string",
- "target": "string"
}
]
}Response samples
- 200
{- "userOperationHash": "string",
- "chainId": 0
}BotAccountsController.submitSolanaTransactionUsingPlatformAuth
Authorizations:
query Parameters
| network | string |
| platform required | string Enum: "telegram" "twitter" "github" Your platform |
header Parameters
| X-ACCESS-TOKEN required | string Your access token for the platform, could be bot tokens or OAuth2 access tokens |
Request Body schema: application/json
Request body for the transaction instructions
| serializedTransactionBase64 required | string The serialized transaction, as a base64 encoded string |
Responses
Request samples
- Payload
{- "serializedTransactionBase64": "string"
}Response samples
- 200
{- "txSignature": "string"
}AnalyticsController.getRolesPie
Authorizations:
path Parameters
| communityId required | string |
query Parameters
| range | string |
Request Body schema: application/json
| color | number |
| id | string |
| name | string |
Responses
Request samples
- Payload
[- {
- "color": 0,
- "id": "string",
- "name": "string"
}
]Response samples
- 200
[- { }
]AnalyticsController.getRolesAdded
Authorizations:
path Parameters
| communityId required | string |
query Parameters
| range | string |
Request Body schema: application/json
| color | number |
| id | string |
| name | string |
Responses
Request samples
- Payload
[- {
- "color": 0,
- "id": "string",
- "name": "string"
}
]Response samples
- 200
[- { }
]AssetOwnershipController.getAssets
Authorizations:
path Parameters
| account required | string |
query Parameters
| assets | Array of strings |
Responses
Response samples
- 200
[- {
- "asset": "string",
- "balance": "string",
- "tokens": [
- {
- "id": "string",
- "balance": "string",
- "uri": "string",
- "metadata": { }
}
]
}
]AssetOwnershipController.verifyOwnership
Authorizations:
path Parameters
| token required | string |
Responses
Response samples
- 200
{- "assets": [
- {
- "asset": "string",
- "owner": true
}
], - "signature": "string",
- "claim": {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "userId": "string",
- "socialId": "string",
- "openseaUrl": "string",
- "mediaUrl": "string",
- "account": "string",
- "assets": [
- "string"
]
}
}AssetOwnershipController.generateJWT
Authorizations:
query Parameters
| format | string Enum: "jwt" "ae" |
Request Body schema: application/json
| classifier | string |
| classifierGroup | string |
| userId | string |
| socialId | string |
| openseaUrl | string |
| mediaUrl | string |
| account | string |
| assets | Array of strings |
Responses
Request samples
- Payload
{- "classifier": "string",
- "classifierGroup": "string",
- "userId": "string",
- "socialId": "string",
- "openseaUrl": "string",
- "mediaUrl": "string",
- "account": "string",
- "assets": [
- "string"
]
}Response samples
- 200
{- "token": "string",
- "slug": "string",
- "url": "string"
}AxieRulesController.getAxieRuleList
Authorizations:
Responses
Response samples
- 200
[- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "communityId": "string",
- "roleId": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string"
}
]ClientApplicationController.getClientAppsForOrg
Authorizations:
path Parameters
| organizationId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "email": "string",
- "tenant": "string",
- "feedback": "string",
- "secret": "string",
- "clientSecret": "string",
- "clientSecretHash": "string",
- "url": "string",
- "clientType": "confidential",
- "redirectUris": [
- "string"
], - "allowedGrantTypes": [
- "string"
], - "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "apiKey": "string",
- "apiKeyHash": "string",
- "allowedOrigins": [
- "string"
], - "allowedReferrers": [
- "string"
], - "allowedIpAddresses": [
- "string"
], - "subscribeEvents": [
- "string"
], - "webhookUrl": "string",
- "icon": "string",
- "createdByName": "string",
- "createdById": "string",
- "requestedScopes": [
- "string"
]
}ClientApplicationController.resetApiKey
Authorizations:
path Parameters
| clientAppId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "email": "string",
- "tenant": "string",
- "feedback": "string",
- "secret": "string",
- "clientSecret": "string",
- "clientSecretHash": "string",
- "url": "string",
- "clientType": "confidential",
- "redirectUris": [
- "string"
], - "allowedGrantTypes": [
- "string"
], - "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "apiKey": "string",
- "apiKeyHash": "string",
- "allowedOrigins": [
- "string"
], - "allowedReferrers": [
- "string"
], - "allowedIpAddresses": [
- "string"
], - "subscribeEvents": [
- "string"
], - "webhookUrl": "string",
- "icon": "string",
- "createdByName": "string",
- "createdById": "string",
- "requestedScopes": [
- "string"
]
}ClientApplicationController.replaceById
Authorizations:
path Parameters
| id required | string |
Request Body schema: application/json
Responses
Request samples
- Payload
{ }Response samples
- 400
- 401
- 403
{- "error": {
- "name": "string",
- "message": "string",
- "statusCode": 0,
- "details": { },
- "stack": "string"
}
}ClientApplicationController.updateClientAppRequest
Authorizations:
path Parameters
| id required | string |
Request Body schema: application/json
| name required | string |
Responses
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "email": "string",
- "tenant": "string",
- "feedback": "string",
- "secret": "string",
- "clientSecret": "string",
- "clientSecretHash": "string",
- "url": "string",
- "clientType": "confidential",
- "redirectUris": [
- "string"
], - "allowedGrantTypes": [
- "string"
], - "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "apiKey": "string",
- "apiKeyHash": "string",
- "allowedOrigins": [
- "string"
], - "allowedReferrers": [
- "string"
], - "allowedIpAddresses": [
- "string"
], - "subscribeEvents": [
- "string"
], - "webhookUrl": "string",
- "icon": "string",
- "createdByName": "string",
- "createdById": "string",
- "requestedScopes": [
- "string"
]
}ClientApplicationController.findById
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "email": "string",
- "tenant": "string",
- "feedback": "string",
- "secret": "string",
- "clientSecret": "string",
- "clientSecretHash": "string",
- "url": "string",
- "clientType": "confidential",
- "redirectUris": [
- "string"
], - "allowedGrantTypes": [
- "string"
], - "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "apiKey": "string",
- "apiKeyHash": "string",
- "allowedOrigins": [
- "string"
], - "allowedReferrers": [
- "string"
], - "allowedIpAddresses": [
- "string"
], - "subscribeEvents": [
- "string"
], - "webhookUrl": "string",
- "icon": "string",
- "createdByName": "string",
- "createdById": "string",
- "requestedScopes": [
- "string"
]
}ClientApplicationController.createClientAppRequest
Authorizations:
Request Body schema: application/json
| pk | string |
| classifierGroup | string |
| name | string |
string | |
| feedback | string Feedback from user |
| clientSecret | string |
| clientSecretHash | string |
| url | string |
| clientType | string Enum: "confidential" "public" "apiKey" |
| redirectUris | Array of strings |
| allowedGrantTypes | Array of strings |
| allowedOrigins | Array of strings |
| allowedReferrers | Array of strings |
| allowedIpAddresses | Array of strings |
| subscribeEvents | Array of strings |
| webhookUrl | string |
| icon | string |
Responses
Request samples
- Payload
{- "pk": "string",
- "classifierGroup": "string",
- "name": "string",
- "email": "string",
- "feedback": "string",
- "clientSecret": "string",
- "clientSecretHash": "string",
- "url": "string",
- "clientType": "confidential",
- "redirectUris": [
- "string"
], - "allowedGrantTypes": [
- "string"
], - "allowedOrigins": [
- "string"
], - "allowedReferrers": [
- "string"
], - "allowedIpAddresses": [
- "string"
], - "subscribeEvents": [
- "string"
], - "webhookUrl": "string",
- "icon": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "email": "string",
- "tenant": "string",
- "feedback": "string",
- "secret": "string",
- "clientSecret": "string",
- "clientSecretHash": "string",
- "url": "string",
- "clientType": "confidential",
- "redirectUris": [
- "string"
], - "allowedGrantTypes": [
- "string"
], - "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "apiKey": "string",
- "apiKeyHash": "string",
- "allowedOrigins": [
- "string"
], - "allowedReferrers": [
- "string"
], - "allowedIpAddresses": [
- "string"
], - "subscribeEvents": [
- "string"
], - "webhookUrl": "string",
- "icon": "string",
- "createdByName": "string",
- "createdById": "string",
- "requestedScopes": [
- "string"
]
}ClientApplicationController.find
Authorizations:
query Parameters
| limit | number |
| paginationToken | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "email": "string",
- "tenant": "string",
- "feedback": "string",
- "secret": "string",
- "clientSecret": "string",
- "clientSecretHash": "string",
- "url": "string",
- "clientType": "confidential",
- "redirectUris": [
- "string"
], - "allowedGrantTypes": [
- "string"
], - "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "apiKey": "string",
- "apiKeyHash": "string",
- "allowedOrigins": [
- "string"
], - "allowedReferrers": [
- "string"
], - "allowedIpAddresses": [
- "string"
], - "subscribeEvents": [
- "string"
], - "webhookUrl": "string",
- "icon": "string",
- "createdByName": "string",
- "createdById": "string",
- "requestedScopes": [
- "string"
]
}
]
}CommunityPlanController.getPlan
Authorizations:
path Parameters
| planId required | string |
Responses
Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "price": 0,
- "billingPeriod": "string",
- "maxAPIKeys": 0,
- "maxMiniApps": 0,
- "rateLimits": { },
- "minBuy": "string",
- "classifier": "string",
- "description": "string",
- "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "userId": "string",
- "timestamp": 0,
- "lockConfig": { },
- "features": { },
- "stripeConfig": { },
- "expirationTime": 0
}CommunityPlanController.getPlans
Authorizations:
Responses
Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "price": 0,
- "billingPeriod": "string",
- "maxAPIKeys": 0,
- "maxMiniApps": 0,
- "rateLimits": { },
- "minBuy": "string",
- "classifier": "string",
- "description": "string",
- "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "userId": "string",
- "timestamp": 0,
- "lockConfig": { },
- "features": { },
- "stripeConfig": { },
- "expirationTime": 0
}CommunityPlanController.getSubscriptions
Authorizations:
path Parameters
| communityId required | string |
Responses
Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "price": 0,
- "billingPeriod": "string",
- "maxAPIKeys": 0,
- "maxMiniApps": 0,
- "rateLimits": { },
- "minBuy": "string",
- "classifier": "string",
- "description": "string",
- "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "userId": "string",
- "timestamp": 0,
- "lockConfig": { },
- "features": { },
- "stripeConfig": { },
- "expirationTime": 0
}CommunityController.getCommunityCredits
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
{- "consumed": 0,
- "remaining": 0,
- "quota": 0,
- "totalTGRsCreated": 0,
- "remainingTGRs": 0,
- "planName": "string",
- "planStatus": "string",
- "renewsInDays": 0,
- "renewalMessage": "string"
}CommunityController.letsGoConfig
Authorizations:
path Parameters
| id required | string |
Request Body schema: application/json
| id | string |
| createdTime | string |
| pk | string |
| sk | string |
| classifier | string |
| classifierGroup | string |
| title | string |
| imageUrl | string |
| donateOptOut | boolean |
| color | string |
| description | string |
Responses
Request samples
- Payload
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "imageUrl": "string",
- "donateOptOut": true,
- "color": "string",
- "description": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "imageUrl": "string",
- "donateOptOut": true,
- "color": "string",
- "description": "string"
}CommunityController.getLetsGoConfig
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "imageUrl": "string",
- "donateOptOut": true,
- "color": "string",
- "description": "string"
}CommunityController.getStats
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
{- "tokenPriceUsd": 0,
- "memberCount": 0,
- "cashtagTweetsInLastDay": 0,
- "cashtagTweetsDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0,
- "myMessageCount": 0,
- "gripStrength": 0,
- "cashtagTweetsPlusMessagesPerDay": 0,
- "dailyVolume": 0
}CommunityController.getGuildTGRInfo
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
]
}CommunityController.getCommunityTGRs
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
]
}CommunityController.replaceTpc
Authorizations:
path Parameters
| id required | string |
| tpcId required | string |
Request Body schema: application/json
| id | string |
| createdTime | string |
| sk | string |
| classifier | string |
| classifierGroup | string |
| name | string |
| description | string |
| roleId | string |
| groupId | string |
| minToken | string <BigDecimal> |
| maxToken | string <BigDecimal> |
| chainId | number |
| tokenSymbol | string |
| tokenId | string |
| collectionName | string |
| eventId | string |
| platform | string |
| contractAddress | string |
| type | string |
| scheme | string |
| query | string |
object | |
| asset | string <CAIPAsset> |
| requiresMetadata | boolean |
| version | string |
| displayName | string |
Responses
Request samples
- Payload
{- "id": "string",
- "createdTime": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}Response samples
- 400
- 401
- 403
{- "error": {
- "name": "string",
- "message": "string",
- "statusCode": 0,
- "details": { },
- "stack": "string"
}
}CommunityController.deleteTpc
Authorizations:
path Parameters
| id required | string |
| tpcId required | string |
Responses
Response samples
- 400
- 401
- 403
{- "error": {
- "name": "string",
- "message": "string",
- "statusCode": 0,
- "details": { },
- "stack": "string"
}
}CommunityController.createTpc
Authorizations:
path Parameters
| id required | string |
Request Body schema: application/json
| createdTime | string |
| classifierGroup | string |
| name | string |
| description | string |
| roleId | string |
| groupId | string |
| minToken | string <BigDecimal> |
| maxToken | string <BigDecimal> |
| chainId | number |
| tokenSymbol | string |
| tokenId | string |
| collectionName | string |
| eventId | string |
| platform | string |
| contractAddress | string |
| type | string |
| scheme | string |
| query | string |
object | |
| asset | string <CAIPAsset> |
| requiresMetadata | boolean |
| version | string |
| displayName | string |
Responses
Request samples
- Payload
{- "createdTime": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}CommunityController.findTpcs
Authorizations:
path Parameters
| id required | string |
query Parameters
| limit | number |
| paginationToken | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
]
}CommunityController.replaceById
Authorizations:
path Parameters
| id required | string |
Request Body schema: application/json
Responses
Request samples
- Payload
{ }Response samples
- 400
- 401
- 403
{- "error": {
- "name": "string",
- "message": "string",
- "statusCode": 0,
- "details": { },
- "stack": "string"
}
}CommunityController.updateById
Authorizations:
path Parameters
| id required | string |
Request Body schema: application/json
| id | string |
| createdTime | string |
| pk | string |
| sk | string |
| classifier | string |
| classifierGroup | string |
| name | string |
| status | string |
| communityId | string |
| ownerId | string |
| adminUserId | string |
| platform | string |
| link | string |
| serverImage | string |
| welcomeMessage | string |
| network | string |
| cashtag | string |
| tokenAddress | string |
| admins | Array of strings |
| activePlans | Array of strings |
| iconURL | string |
| inviteLink | string |
Array of objects (Channel) | |
Array of objects (Quest) | |
Array of objects (Drop) | |
object (Stats) | |
Array of objects (TokenPermissionedChat) | |
| disableBkgBalCheck | boolean |
| enableAddRoles | boolean |
| disablePromotionalUpdates | boolean |
| bkgTimestamp | number |
| letsGo | number |
| memberChecked | number |
| memberCount | number |
| memberCountInDB | number |
| memberCountInGuild | number |
| memberIgnored | number |
| tgrUpdated | number |
| maxAllowedUnits | number |
| consumedUnits | number |
| unitsLastUpdated | number |
| property name* additional property | any |
Responses
Request samples
- Payload
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "status": "string",
- "communityId": "string",
- "ownerId": "string",
- "adminUserId": "string",
- "platform": "string",
- "link": "string",
- "serverImage": "string",
- "welcomeMessage": "string",
- "network": "string",
- "cashtag": "string",
- "tokenAddress": "string",
- "admins": [
- "string"
], - "activePlans": [
- "string"
], - "iconURL": "string",
- "inviteLink": "string",
- "channels": [
- {
- "name": "string",
- "link": "string",
- "tokenAmountToEnter": 0,
- "members": 0,
- "membersInLastDay": 0,
- "membersDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0
}
], - "quests": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string",
- "stripePaymentIntent": "string",
- "published": true
}
], - "drops": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "chainId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string"
}
], - "stats": {
- "tokenPriceUsd": 0,
- "memberCount": 0,
- "cashtagTweetsInLastDay": 0,
- "cashtagTweetsDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0,
- "myMessageCount": 0,
- "gripStrength": 0,
- "cashtagTweetsPlusMessagesPerDay": 0,
- "dailyVolume": 0
}, - "tpcs": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
], - "disableBkgBalCheck": true,
- "enableAddRoles": true,
- "disablePromotionalUpdates": true,
- "bkgTimestamp": 0,
- "letsGo": 0,
- "memberChecked": 0,
- "memberCount": 0,
- "memberCountInDB": 0,
- "memberCountInGuild": 0,
- "memberIgnored": 0,
- "tgrUpdated": 0,
- "maxAllowedUnits": 0,
- "consumedUnits": 0,
- "unitsLastUpdated": 0
}Response samples
- 400
- 401
- 403
{- "error": {
- "name": "string",
- "message": "string",
- "statusCode": 0,
- "details": { },
- "stack": "string"
}
}CommunityController.findById
Authorizations:
path Parameters
| id required | string |
query Parameters
| include | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "status": "string",
- "communityId": "string",
- "ownerId": "string",
- "adminUserId": "string",
- "platform": "string",
- "link": "string",
- "serverImage": "string",
- "welcomeMessage": "string",
- "network": "string",
- "cashtag": "string",
- "tokenAddress": "string",
- "admins": [
- "string"
], - "activePlans": [
- "string"
], - "iconURL": "string",
- "inviteLink": "string",
- "channels": [
- {
- "name": "string",
- "link": "string",
- "tokenAmountToEnter": 0,
- "members": 0,
- "membersInLastDay": 0,
- "membersDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0
}
], - "quests": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string",
- "stripePaymentIntent": "string",
- "published": true
}
], - "drops": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "chainId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string"
}
], - "stats": {
- "tokenPriceUsd": 0,
- "memberCount": 0,
- "cashtagTweetsInLastDay": 0,
- "cashtagTweetsDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0,
- "myMessageCount": 0,
- "gripStrength": 0,
- "cashtagTweetsPlusMessagesPerDay": 0,
- "dailyVolume": 0
}, - "tpcs": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
], - "disableBkgBalCheck": true,
- "enableAddRoles": true,
- "disablePromotionalUpdates": true,
- "bkgTimestamp": 0,
- "letsGo": 0,
- "memberChecked": 0,
- "memberCount": 0,
- "memberCountInDB": 0,
- "memberCountInGuild": 0,
- "memberIgnored": 0,
- "tgrUpdated": 0,
- "maxAllowedUnits": 0,
- "consumedUnits": 0,
- "unitsLastUpdated": 0
}CommunityController.create
Authorizations:
Request Body schema: application/json
| createdTime | string |
| pk | string |
| sk | string |
| classifier | string |
| classifierGroup | string |
| name | string |
| status | string |
| communityId | string |
| ownerId | string |
| adminUserId | string |
| platform | string |
| serverImage | string |
| welcomeMessage | string |
| network | string |
| cashtag | string |
| tokenAddress | string |
| admins | Array of strings |
| activePlans | Array of strings |
| iconURL | string |
| inviteLink | string |
Array of objects (Channel) | |
Array of objects (Quest) | |
Array of objects (Drop) | |
object (Stats) | |
Array of objects (TokenPermissionedChat) | |
| disableBkgBalCheck | boolean |
| enableAddRoles | boolean |
| disablePromotionalUpdates | boolean |
| bkgTimestamp | number |
| letsGo | number |
| memberChecked | number |
| memberCount | number |
| memberCountInDB | number |
| memberCountInGuild | number |
| memberIgnored | number |
| tgrUpdated | number |
| maxAllowedUnits | number |
| consumedUnits | number |
| unitsLastUpdated | number |
| property name* additional property | any |
Responses
Request samples
- Payload
{- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "status": "string",
- "communityId": "string",
- "ownerId": "string",
- "adminUserId": "string",
- "platform": "string",
- "serverImage": "string",
- "welcomeMessage": "string",
- "network": "string",
- "cashtag": "string",
- "tokenAddress": "string",
- "admins": [
- "string"
], - "activePlans": [
- "string"
], - "iconURL": "string",
- "inviteLink": "string",
- "channels": [
- {
- "name": "string",
- "link": "string",
- "tokenAmountToEnter": 0,
- "members": 0,
- "membersInLastDay": 0,
- "membersDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0
}
], - "quests": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string",
- "stripePaymentIntent": "string",
- "published": true
}
], - "drops": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "chainId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string"
}
], - "stats": {
- "tokenPriceUsd": 0,
- "memberCount": 0,
- "cashtagTweetsInLastDay": 0,
- "cashtagTweetsDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0,
- "myMessageCount": 0,
- "gripStrength": 0,
- "cashtagTweetsPlusMessagesPerDay": 0,
- "dailyVolume": 0
}, - "tpcs": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
], - "disableBkgBalCheck": true,
- "enableAddRoles": true,
- "disablePromotionalUpdates": true,
- "bkgTimestamp": 0,
- "letsGo": 0,
- "memberChecked": 0,
- "memberCount": 0,
- "memberCountInDB": 0,
- "memberCountInGuild": 0,
- "memberIgnored": 0,
- "tgrUpdated": 0,
- "maxAllowedUnits": 0,
- "consumedUnits": 0,
- "unitsLastUpdated": 0
}Response samples
- 200
- 400
- 401
- 403
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "status": "string",
- "communityId": "string",
- "ownerId": "string",
- "adminUserId": "string",
- "platform": "string",
- "link": "string",
- "serverImage": "string",
- "welcomeMessage": "string",
- "network": "string",
- "cashtag": "string",
- "tokenAddress": "string",
- "admins": [
- "string"
], - "activePlans": [
- "string"
], - "iconURL": "string",
- "inviteLink": "string",
- "channels": [
- {
- "name": "string",
- "link": "string",
- "tokenAmountToEnter": 0,
- "members": 0,
- "membersInLastDay": 0,
- "membersDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0
}
], - "quests": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string",
- "stripePaymentIntent": "string",
- "published": true
}
], - "drops": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "chainId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string"
}
], - "stats": {
- "tokenPriceUsd": 0,
- "memberCount": 0,
- "cashtagTweetsInLastDay": 0,
- "cashtagTweetsDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0,
- "myMessageCount": 0,
- "gripStrength": 0,
- "cashtagTweetsPlusMessagesPerDay": 0,
- "dailyVolume": 0
}, - "tpcs": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
], - "disableBkgBalCheck": true,
- "enableAddRoles": true,
- "disablePromotionalUpdates": true,
- "bkgTimestamp": 0,
- "letsGo": 0,
- "memberChecked": 0,
- "memberCount": 0,
- "memberCountInDB": 0,
- "memberCountInGuild": 0,
- "memberIgnored": 0,
- "tgrUpdated": 0,
- "maxAllowedUnits": 0,
- "consumedUnits": 0,
- "unitsLastUpdated": 0
}CommunityController.find
Authorizations:
query Parameters
| limit | number |
| paginationToken | string |
| include | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "status": "string",
- "communityId": "string",
- "ownerId": "string",
- "adminUserId": "string",
- "platform": "string",
- "link": "string",
- "serverImage": "string",
- "welcomeMessage": "string",
- "network": "string",
- "cashtag": "string",
- "tokenAddress": "string",
- "admins": [
- "string"
], - "activePlans": [
- "string"
], - "iconURL": "string",
- "inviteLink": "string",
- "channels": [
- {
- "name": "string",
- "link": "string",
- "tokenAmountToEnter": 0,
- "members": 0,
- "membersInLastDay": 0,
- "membersDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0
}
], - "quests": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string",
- "stripePaymentIntent": "string",
- "published": true
}
], - "drops": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "title": "string",
- "reward": "string",
- "total": 0,
- "remaining": 0,
- "deadline": 0,
- "communityId": "string",
- "chainId": "string",
- "tokenAddress": "string",
- "cashtag": "string",
- "tokenSymbol": "string",
- "createdByName": "string",
- "createdById": "string",
- "claimedBy": [
- "string"
], - "claimedByTime": [
- "string"
], - "link": "string"
}
], - "stats": {
- "tokenPriceUsd": 0,
- "memberCount": 0,
- "cashtagTweetsInLastDay": 0,
- "cashtagTweetsDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0,
- "myMessageCount": 0,
- "gripStrength": 0,
- "cashtagTweetsPlusMessagesPerDay": 0,
- "dailyVolume": 0
}, - "tpcs": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleId": "string",
- "groupId": "string",
- "minToken": "string",
- "maxToken": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "tokenId": "string",
- "collectionName": "string",
- "eventId": "string",
- "platform": "string",
- "contractAddress": "string",
- "type": "string",
- "scheme": "string",
- "query": "string",
- "variables": { },
- "asset": "string",
- "requiresMetadata": true,
- "version": "string",
- "displayName": "string"
}
], - "disableBkgBalCheck": true,
- "enableAddRoles": true,
- "disablePromotionalUpdates": true,
- "bkgTimestamp": 0,
- "letsGo": 0,
- "memberChecked": 0,
- "memberCount": 0,
- "memberCountInDB": 0,
- "memberCountInGuild": 0,
- "memberIgnored": 0,
- "tgrUpdated": 0,
- "maxAllowedUnits": 0,
- "consumedUnits": 0,
- "unitsLastUpdated": 0
}
]
}MiniAppController.installMiniApp
Authorizations:
path Parameters
| communityId required | string |
| appId required | string |
Request Body schema: application/json
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "appId": "string",
- "clientId": "string",
- "appType": "string",
- "developer": "string",
- "name": "string",
- "shortName": "string",
- "supportedEnvs": [
- "string"
], - "supportedCommunities": [
- "string"
], - "releasedDate": 0,
- "version": {
- "name": "string",
- "changelog": "string"
}, - "keywords": [
- "string"
], - "tags": [
- "string"
], - "category": "string",
- "website": "string",
- "shortDescription": "string",
- "description": "string",
- "thumbnails": [
- { }
], - "icons": [
- { }
], - "platforms": [
- "string"
], - "type": "string",
- "price": 0,
- "subscribedEvents": [
- "string"
], - "webhookUrl": "string",
- "template": "string",
- "isBeta": true
}MiniAppController.getMiniAppsForCommunity
Authorizations:
path Parameters
| communityId required | string |
query Parameters
| installedOnly | boolean |
Responses
Response samples
- 200
{- "appId": "string",
- "clientId": "string",
- "appType": "string",
- "developer": "string",
- "name": "string",
- "shortName": "string",
- "supportedEnvs": [
- "string"
], - "supportedCommunities": [
- "string"
], - "releasedDate": 0,
- "version": {
- "name": "string",
- "changelog": "string"
}, - "keywords": [
- "string"
], - "tags": [
- "string"
], - "category": "string",
- "website": "string",
- "shortDescription": "string",
- "description": "string",
- "thumbnails": [
- { }
], - "icons": [
- { }
], - "platforms": [
- "string"
], - "type": "string",
- "price": 0,
- "subscribedEvents": [
- "string"
], - "webhookUrl": "string",
- "template": "string",
- "isBeta": true
}CommunityWalletController.createWallet
Authorizations:
path Parameters
| communityId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "address": "string",
- "ownerAddress": "string",
- "txHash": "string",
- "userId": "string",
- "platform": "string",
- "clTokenBalance": "string",
- "timestamp": 0,
- "communityId": "string"
}CommunityWalletController.getWalletDetail
Authorizations:
path Parameters
| communityId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "address": "string",
- "ownerAddress": "string",
- "txHash": "string",
- "userId": "string",
- "platform": "string",
- "clTokenBalance": "string",
- "timestamp": 0,
- "communityId": "string"
}ConfigController.getConfig
Authorizations:
Responses
Response samples
- 200
{- "jwtPublicKey": "string",
- "discordClientId": "string",
- "actionEcdsaPublicKey": "string",
- "actionEd25519PublicKey": "string",
- "actionEd25519PublicKeyHex": "string"
}PlanController.getPlan
Authorizations:
path Parameters
| planId required | string |
Responses
Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "price": 0,
- "billingPeriod": "string",
- "maxAPIKeys": 0,
- "maxMiniApps": 0,
- "rateLimits": { },
- "minBuy": "string",
- "classifier": "string",
- "description": "string",
- "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "userId": "string",
- "timestamp": 0,
- "lockConfig": { },
- "features": { },
- "stripeConfig": { },
- "expirationTime": 0
}PlanController.getPlans
Authorizations:
Responses
Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "price": 0,
- "billingPeriod": "string",
- "maxAPIKeys": 0,
- "maxMiniApps": 0,
- "rateLimits": { },
- "minBuy": "string",
- "classifier": "string",
- "description": "string",
- "allowedScopes": [
- "string"
], - "disallowedScopes": [
- "string"
], - "userId": "string",
- "timestamp": 0,
- "lockConfig": { },
- "features": { },
- "stripeConfig": { },
- "expirationTime": 0
}OrganizationController.verifyOrganization
Authorizations:
Request Body schema: application/json
| otp required | string |
Responses
Request samples
- Payload
{- "otp": "string"
}Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "email": "string",
- "createdTime": 0,
- "classifier": "string",
- "userId": "string",
- "planId": "string"
}OrganizationController.getOrganization
Authorizations:
path Parameters
| orgId required | string |
Responses
Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "email": "string",
- "createdTime": 0,
- "classifier": "string",
- "userId": "string",
- "planId": "string"
}OrganizationController.createOrganization
Authorizations:
Request Body schema: application/json
| pk | string |
| name required | string |
| email required | string |
Responses
Request samples
- Payload
{- "pk": "string",
- "name": "string",
- "email": "string"
}Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "email": "string",
- "createdTime": 0,
- "classifier": "string",
- "userId": "string",
- "planId": "string"
}OrganizationController.getOrganizations
Authorizations:
Responses
Response samples
- 200
{- "pk": "string",
- "sk": "string",
- "name": "string",
- "email": "string",
- "createdTime": 0,
- "classifier": "string",
- "userId": "string",
- "planId": "string"
}OrganizationWalletController.createWallet
Authorizations:
path Parameters
| orgId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "address": "string",
- "ownerAddress": "string",
- "txHash": "string",
- "userId": "string",
- "platform": "string",
- "clTokenBalance": "string",
- "organizationId": "string",
- "gnosisAddress": "string",
- "chainId": 0
}OrganizationWalletController.getWalletDetail
Authorizations:
path Parameters
| orgId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "address": "string",
- "ownerAddress": "string",
- "txHash": "string",
- "userId": "string",
- "platform": "string",
- "clTokenBalance": "string",
- "organizationId": "string",
- "gnosisAddress": "string",
- "chainId": 0
}DiscordBotController.checkBotConfig
Authorizations:
path Parameters
| communityId required | string |
Responses
Response samples
- 200
{- "status": "string",
- "errors": [
- {
- "code": "string",
- "action": "string",
- "link": "string",
- "details": null
}
]
}DiscordIntegrationController.getDiscordGuildMemberCount
Authorizations:
path Parameters
| guildId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "memberCount": 0,
- "channels": [
- {
- "id": "string",
- "name": "string",
- "type": "string"
}
], - "roles": [
- {
- "id": "string",
- "name": "string",
- "color": 0
}
]
}DiscordIntegrationController.createDiscordRole
Authorizations:
path Parameters
| guildId required | string |
Request Body schema: application/json
| name required | string |
| color | string |
| hoist | boolean |
| position | number |
| mentionable | boolean |
| permissions | number |
Responses
Request samples
- Payload
{- "name": "string",
- "color": "string",
- "hoist": true,
- "position": 0,
- "mentionable": true,
- "permissions": 0
}DiscordIntegrationController.getDiscordGuild
Authorizations:
path Parameters
| guildId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "memberCount": 0,
- "channels": [
- {
- "id": "string",
- "name": "string",
- "type": "string"
}
], - "roles": [
- {
- "id": "string",
- "name": "string",
- "color": 0
}
]
}DiscordIntegrationController.sendDiscordMessage
Authorizations:
path Parameters
| guildId required | string |
| channelId required | string |
Request Body schema: application/json
Responses
Request samples
- Payload
{ }Response samples
- 200
nullDiscordIntegrationController.findChannels
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "name": "string",
- "link": "string",
- "tokenAmountToEnter": 0,
- "members": 0,
- "membersInLastDay": 0,
- "membersDailyGrowth": 0,
- "messagesInLastDay": 0,
- "messagesAllTime": 0,
- "messagesDailyGrowth": 0
}
]
}DiscordIntegrationController.getMemberInfo
Authorizations:
path Parameters
| guildId required | string |
| memberId required | string |
Responses
Response samples
- 200
{- "user": {
- "id": "string",
- "username": "string",
- "discriminator": "string",
- "avatar": "string",
- "bot": true,
- "system": true,
- "mfa_enabled": true,
- "banner": "string",
- "accent_color": 0,
- "locale": "string",
- "verified": true,
- "email": "string",
- "flags": "Staff",
- "premium_type": {
- "0": "None",
- "1": "NitroClassic",
- "2": "Nitro",
- "3": "NitroBasic",
- "None": 0,
- "NitroClassic": 1,
- "Nitro": 2,
- "NitroBasic": 3
}, - "public_flags": {
- "1": "Staff",
- "2": "Partner",
- "4": "Hypesquad",
- "8": "BugHunterLevel1",
- "16": "MFASMS",
- "32": "PremiumPromoDismissed",
- "64": "HypeSquadOnlineHouse1",
- "128": "HypeSquadOnlineHouse2",
- "256": "HypeSquadOnlineHouse3",
- "512": "PremiumEarlySupporter",
- "1024": "TeamPseudoUser",
- "8192": "HasUnreadUrgentMessages",
- "16384": "BugHunterLevel2",
- "65536": "VerifiedBot",
- "131072": "VerifiedDeveloper",
- "262144": "CertifiedModerator",
- "524288": "BotHTTPInteractions",
- "1048576": "Spammer",
- "2097152": "DisablePremium",
- "4194304": "ActiveDeveloper",
- "Staff": 1,
- "Partner": 2,
- "Hypesquad": 4,
- "BugHunterLevel1": 8,
- "MFASMS": 16,
- "PremiumPromoDismissed": 32,
- "HypeSquadOnlineHouse1": 64,
- "HypeSquadOnlineHouse2": 128,
- "HypeSquadOnlineHouse3": 256,
- "PremiumEarlySupporter": 512,
- "TeamPseudoUser": 1024,
- "HasUnreadUrgentMessages": 8192,
- "BugHunterLevel2": 16384,
- "VerifiedBot": 65536,
- "VerifiedDeveloper": 131072,
- "CertifiedModerator": 262144,
- "BotHTTPInteractions": 524288,
- "Spammer": 1048576,
- "DisablePremium": 2097152,
- "ActiveDeveloper": 4194304,
- "Quarantined": 17592186044416,
- "17592186044416": "Quarantined",
- "Collaborator": 1125899906842624,
- "1125899906842624": "Collaborator",
- "RestrictedCollaborator": 2251799813685248,
- "2251799813685248": "RestrictedCollaborator"
}
}, - "nick": "string",
- "avatar": "string",
- "roles": [
- "string"
], - "joined_at": "string",
- "premium_since": "string",
- "deaf": true,
- "mute": true,
- "pending": true,
- "communication_disabled_until": "string"
}DiscordIntegrationController.getGuildActiveMembers
Authorizations:
path Parameters
| guildId required | string |
query Parameters
| limit | number |
| paginationToken | string |
Responses
Response samples
- 200
[- {
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "source": "string",
- "timestamp": 0
}
]DiscordIntegrationController.getGuildMembers
Authorizations:
path Parameters
| guildId required | string |
query Parameters
| limit | number |
| before | string |
| after | string |
Responses
Response samples
- 200
[- {
- "user": {
- "id": "string",
- "username": "string",
- "discriminator": "string",
- "avatar": "string",
- "bot": true,
- "system": true,
- "mfa_enabled": true,
- "banner": "string",
- "accent_color": 0,
- "locale": "string",
- "verified": true,
- "email": "string",
- "flags": "Staff",
- "premium_type": {
- "0": "None",
- "1": "NitroClassic",
- "2": "Nitro",
- "3": "NitroBasic",
- "None": 0,
- "NitroClassic": 1,
- "Nitro": 2,
- "NitroBasic": 3
}, - "public_flags": {
- "1": "Staff",
- "2": "Partner",
- "4": "Hypesquad",
- "8": "BugHunterLevel1",
- "16": "MFASMS",
- "32": "PremiumPromoDismissed",
- "64": "HypeSquadOnlineHouse1",
- "128": "HypeSquadOnlineHouse2",
- "256": "HypeSquadOnlineHouse3",
- "512": "PremiumEarlySupporter",
- "1024": "TeamPseudoUser",
- "8192": "HasUnreadUrgentMessages",
- "16384": "BugHunterLevel2",
- "65536": "VerifiedBot",
- "131072": "VerifiedDeveloper",
- "262144": "CertifiedModerator",
- "524288": "BotHTTPInteractions",
- "1048576": "Spammer",
- "2097152": "DisablePremium",
- "4194304": "ActiveDeveloper",
- "Staff": 1,
- "Partner": 2,
- "Hypesquad": 4,
- "BugHunterLevel1": 8,
- "MFASMS": 16,
- "PremiumPromoDismissed": 32,
- "HypeSquadOnlineHouse1": 64,
- "HypeSquadOnlineHouse2": 128,
- "HypeSquadOnlineHouse3": 256,
- "PremiumEarlySupporter": 512,
- "TeamPseudoUser": 1024,
- "HasUnreadUrgentMessages": 8192,
- "BugHunterLevel2": 16384,
- "VerifiedBot": 65536,
- "VerifiedDeveloper": 131072,
- "CertifiedModerator": 262144,
- "BotHTTPInteractions": 524288,
- "Spammer": 1048576,
- "DisablePremium": 2097152,
- "ActiveDeveloper": 4194304,
- "Quarantined": 17592186044416,
- "17592186044416": "Quarantined",
- "Collaborator": 1125899906842624,
- "1125899906842624": "Collaborator",
- "RestrictedCollaborator": 2251799813685248,
- "2251799813685248": "RestrictedCollaborator"
}
}, - "nick": "string",
- "avatar": "string",
- "roles": [
- "string"
], - "joined_at": "string",
- "premium_since": "string",
- "deaf": true,
- "mute": true,
- "pending": true,
- "communication_disabled_until": "string"
}
]DiscordIntegrationController.getGuildRoles
Authorizations:
path Parameters
| guildId required | string |
Responses
Response samples
- 200
[- {
- "id": "string",
- "name": "string",
- "color": 0,
- "hoist": true,
- "icon": "string",
- "unicode_emoji": "string",
- "position": 0,
- "permissions": [
- "string"
], - "managed": true,
- "mentionable": true,
- "tags": {
- "bot_id": "string",
- "premium_subscriber": true,
- "integration_id": "string"
}
}
]GuestPassController.createGuestPass
Authorizations:
path Parameters
| guildId required | string |
Request Body schema: application/json
| id | string |
| createdTime | string |
| pk | string |
| sk | string |
| classifier | string |
| classifierGroup | string |
| name | string |
| description | string |
Array of objects (Role) | |
| platform | string |
| status | string |
| period | number |
Responses
Request samples
- Payload
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "roleSet": [
- {
- "id": "string",
- "name": "string",
- "color": 0
}
], - "platform": "string",
- "status": "string",
- "period": 0
}Response samples
- 200
{ }EthereumBalanceController.getBalances
Authorizations:
Request Body schema: application/json
| account | string |
Array of objects (EthereumAsset) |
Responses
Request samples
- Payload
{- "account": "string",
- "assets": [
- {
- "chainId": 0,
- "token": "string"
}
]
}Response samples
- 200
{- "balances": [
- {
- "chainId": 0,
- "token": "string",
- "balance": "string"
}
]
}EthereumBalanceController.getTransactionStatus
Authorizations:
path Parameters
| chainId required | string |
| txHash required | string |
Responses
Response samples
- 200
{- "success": true,
- "confirmations": 0,
- "from": "string",
- "to": "string",
- "link": "string"
}EthereumLoginController.getChallenge
Authorizations:
Request Body schema: application/json
| state | string State/nonce from the client |
| uri | string URI referring to the resource that is the subject of the signing (as in the subject of a claim). |
| domain | string Domain name of the server that is requesting the signature. |
| accountId | string Account id of the signer |
| resources | Array of strings |
Responses
Request samples
- Payload
{- "state": "string",
- "uri": "string",
- "domain": "string",
- "accountId": "string",
- "resources": [
- "string"
]
}Response samples
- 200
{- "state": "string",
- "requestId": "string",
- "message": "string"
}EthereumLoginController.loginBySIWE
Authorizations:
Request Body schema: application/json
| requestId required | string Unique request id for the login |
| signatureType | string Signature type |
| signature required | string Signature of the message for the given login |
| accountId | string Account id of the signer |
| scopes | string Permission scopes granted to this login action |
Responses
Request samples
- Payload
{- "requestId": "string",
- "signatureType": "string",
- "signature": "string",
- "accountId": "string",
- "scopes": "string"
}Response samples
- 200
{- "idToken": "string"
}EvmNetworkConfigController.getNetworkConfigs
Authorizations:
Responses
Response samples
- 200
[- {
- "chainId": 0,
- "description": "string",
- "names": [
- "string"
], - "rpcs": [
- "string"
], - "explorers": [
- "string"
], - "maxBlocks": 0,
- "concurrency": 0,
- "providers": [
- "string"
], - "hidden": true
}
]EvmNetworkConfigController.getEvmTokens
Authorizations:
path Parameters
| network required | string |
Responses
Response samples
- 200
[- {
- "contractName": "string",
- "address": "string",
- "icon": "string",
- "tokenName": "string",
- "tokenSymbol": "string",
- "tokenType": "string",
- "decimals": 0
}
]EthereumWalletConnectionVenlyController.callback
Authorizations:
Request Body schema: application/json
| id | string |
| address | string |
| accountId | string |
object | |
| verifyOnly | boolean A flag to verify the wallet without saving it |
| proxyType | string |
| walletType | string |
| selectedWallet | string |
| venlyWallets | string |
| network | string |
object (VenlyCompositeSignature) | |
| state | string |
Responses
Request samples
- Payload
{- "id": "string",
- "address": "string",
- "accountId": "string",
- "metadata": {
- "property1": true,
- "property2": true
}, - "verifyOnly": true,
- "proxyType": "string",
- "walletType": "string",
- "selectedWallet": "string",
- "venlyWallets": "string",
- "network": "string",
- "venlyWalletData": {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "nickname": "string",
- "userId": "string",
- "username": "string"
}, - "state": "string"
}Response samples
- 200
{- "success": true,
- "address": "string",
- "proxies": [
- {
- "proxyAddresses": [
- "string"
], - "proxyAccounts": [
- "string"
], - "proxyType": "string"
}
], - "state": "string",
- "message": "string",
- "code": "string",
- "resetToken": "string",
- "connection": {
- "user": {
- "platform": "string",
- "id": "string",
- "userPk": "string",
- "name": "string",
- "communityId": "string",
- "communityPk": "string",
- "communityName": "string",
- "state": "string",
- "message": "string"
}, - "walletType": "string",
- "address": "string",
- "accountId": "string"
}
}FlowContractsController.getContracts
Authorizations:
Responses
Response samples
- 200
{- "nfts": [
- {
- "address": "string",
- "name": "string",
- "label": "string",
- "collection": "string",
- "path": "string",
- "id": "string",
- "supportsMetadata": true
}
], - "fts": [
- {
- "address": "string",
- "name": "string",
- "path": "string"
}
]
}FreshdeskController.createTicket
Authorizations:
Request Body schema: application/json
| subject required | string |
| description required | string |
| communityId required | string |
| type | string |
| priority | number |
| parent_id | number |
| status | number |
| requester_id | number |
| responder_id | number |
| custom_fields | object |
| group_id | number |
| product_id | number |
| email required | string |
| tags | Array of strings |
| cc_emails | Array of strings |
Responses
Request samples
- Payload
{- "subject": "string",
- "description": "string",
- "communityId": "string",
- "type": "string",
- "priority": 0,
- "parent_id": 0,
- "status": 0,
- "requester_id": 0,
- "responder_id": 0,
- "custom_fields": { },
- "group_id": 0,
- "product_id": 0,
- "email": "string",
- "tags": [
- "string"
], - "cc_emails": [
- "string"
]
}Response samples
- 200
{- "cc_emails": [
- "string"
], - "fwd_emails": [
- { }
], - "reply_cc_emails": [
- "string"
], - "ticket_cc_emails": [
- "string"
], - "fr_escalated": true,
- "spam": true,
- "email_config_id": { },
- "group_id": { },
- "priority": 0,
- "requester_id": 0,
- "responder_id": { },
- "source": 0,
- "company_id": { },
- "status": 0,
- "subject": "string",
- "to_emails": { },
- "product_id": { },
- "id": 0,
- "type": "string",
- "due_by": "string",
- "fr_due_by": "string",
- "is_escalated": true,
- "description": "string",
- "description_text": "string",
- "custom_fields": { },
- "created_at": "string",
- "updated_at": "string",
- "tags": [
- "string"
], - "attachments": [
- { }
], - "nr_due_by": { },
- "nr_escalated": true
}FreshdeskController.listTickets
Authorizations:
query Parameters
| filter | string |
| include | string |
| companyId | number |
| requesterId | number |
string | |
| updatedSince | string |
| orderBy | string |
| orderType | string |
Responses
Response samples
- 200
{- "data": [
- { }
], - "status": 0
}GithubAccountsController.calculateGithubRepoAccount
Authorizations:
Request Body schema: application/json
| repoID required | string Github repo ID |
| chainId required | number Chain ID |
Responses
Request samples
- Payload
{- "repoID": "string",
- "chainId": 0
}Response samples
- 200
{- "account": "string"
}HelloActionController.handleEvent
Authorizations:
header Parameters
| X-Signature-Timestamp required | number |
| X-Signature-Ecdsa | string |
| X-Signature-Ed25519 | string |
Request Body schema: application/json
Responses
Request samples
- Payload
"string"HelloActionController.handleInteraction
Authorizations:
header Parameters
| X-Signature-Timestamp required | number |
| X-Signature-Ecdsa | string |
| X-Signature-Ed25519 | string |
Request Body schema: application/json
Responses
Request samples
- Payload
"string"Response samples
- 200
{ }HelloActionController.loadMetadata
Authorizations:
Responses
Response samples
- 200
{- "signatureType": "string",
- "manifest": {
- "appId": "string",
- "clientId": "string",
- "appType": "string",
- "developer": "string",
- "name": "string",
- "shortName": "string",
- "supportedEnvs": [
- "string"
], - "supportedCommunities": [
- "string"
], - "releasedDate": 0,
- "version": {
- "name": "string",
- "changelog": "string"
}, - "keywords": [
- "string"
], - "tags": [
- "string"
], - "category": "string",
- "website": "string",
- "shortDescription": "string",
- "description": "string",
- "thumbnails": [
- { }
], - "icons": [
- { }
], - "platforms": [
- "string"
], - "type": "string",
- "price": 0,
- "subscribedEvents": [
- "string"
], - "webhookUrl": "string",
- "template": "string",
- "isBeta": true
}, - "applicationCommands": [
- { }
], - "supportedInteractions": [
- {
- "type": 2,
- "nameOrIdPattern": "string"
}
], - "requiredContext": [
- "string"
]
}L2TipController.getAccountAddress
Authorizations:
path Parameters
| communityPK required | string |
Request Body schema: application/json
| userId required | string The user ID of the account |
| platform required | string Enum: "discord" "telegram" The platform for the account |
Responses
Request samples
- Payload
{- "userId": "string",
- "platform": "discord"
}L2TipController.getL2TipChains
Authorizations:
path Parameters
| communityPK required | string |
Responses
Response samples
- 200
{- "chains": [
- {
- "chainId": 0,
- "chainLabel": "string",
- "isSelected": true,
- "tokens": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "chainId": 0,
- "tokenSymbol": "string",
- "contractAddress": "string",
- "decimals": 0,
- "tokenName": "string",
- "isAirdropToken": true,
- "isDefaultGasToken": true,
- "fallbackPriceUSD": 0,
- "isSponsored": true,
- "sponsorshipMessage": "string"
}
]
}
], - "royaltyWalletAddress": "string",
- "auditLogs": [
- {
- "timestamp": 0,
- "message": "string",
- "userId": "string",
- "username": "string"
}
]
}LogSettingsController.updateDebugSettings
Authorizations:
query Parameters
| wait | integer <int32> Number of seconds to wait for updated settings |
Request Body schema: application/json
| serverTypes | Array of strings |
| hostNames | Array of strings |
| logLevel | string |
| debugSettings | string |
Responses
Request samples
- Payload
[- {
- "serverTypes": [
- "string"
], - "hostNames": [
- "string"
], - "logLevel": "string",
- "debugSettings": "string"
}
]Response samples
- 200
[- {
- "serverType": "string",
- "serverSubType": "string",
- "hostName": "string",
- "logLevel": "string",
- "debugSettings": "string"
}
]LogSettingsController.collectLogSettings
Authorizations:
query Parameters
| wait | integer <int32> Number of seconds to wait for collected settings |
Responses
Response samples
- 200
[- {
- "serverType": "string",
- "serverSubType": "string",
- "hostName": "string",
- "logLevel": "string",
- "debugSettings": "string"
}
]MiniappRegistrationController.getMiniApps
Authorizations:
path Parameters
| organizationId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "icon": "string",
- "description": "string",
- "feedback": "string",
- "url": "string",
- "platforms": [
- "string"
], - "privateKey": "string",
- "publicKey": "string",
- "metadata": { }
}MiniappRegistrationController.resetSecret
Authorizations:
path Parameters
| miniAppId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "icon": "string",
- "description": "string",
- "feedback": "string",
- "url": "string",
- "platforms": [
- "string"
], - "privateKey": "string",
- "publicKey": "string",
- "metadata": { }
}MiniappRegistrationController.updateMiniApp
Authorizations:
path Parameters
| miniAppId required | string |
Request Body schema: application/json
| name required | string |
Responses
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "icon": "string",
- "description": "string",
- "feedback": "string",
- "url": "string",
- "platforms": [
- "string"
], - "privateKey": "string",
- "publicKey": "string",
- "metadata": { }
}MiniappRegistrationController.createMiniApp
Authorizations:
Request Body schema: application/json
| pk | string |
| name required | string Name of the app. |
| icon | string Url of icon for the app |
| description required | string Description of App for which this is requested |
| feedback | string Feedback from user |
| url | string Action url |
| platforms | Array of strings |
| metadata | object metadata |
Responses
Request samples
- Payload
{- "pk": "string",
- "name": "string",
- "icon": "string",
- "description": "string",
- "feedback": "string",
- "url": "string",
- "platforms": [
- "string"
], - "metadata": { }
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "status": "string",
- "actions": [
- { }
], - "name": "string",
- "icon": "string",
- "description": "string",
- "feedback": "string",
- "url": "string",
- "platforms": [
- "string"
], - "privateKey": "string",
- "publicKey": "string",
- "metadata": { }
}NearIndexerController.getReceipt
Authorizations:
path Parameters
| receiptId required | string |
query Parameters
| include | string |
Responses
Response samples
- 200
{- "included_in_block_hash": "string",
- "included_in_block_timestamp": 0,
- "included_in_chunk_hash": "string",
- "index_in_chunk": 0,
- "originated_from_transaction_hash": "string",
- "predecessor_account_id": "string",
- "receipt_id": "string",
- "receipt_kind": "ACTION",
- "receiver_account_id": "string"
}NearIndexerController.getTransaction
Authorizations:
path Parameters
| txHash required | string |
query Parameters
| include | string |
Responses
Response samples
- 200
{- "block_timestamp": 0,
- "converted_into_receipt_id": "string",
- "included_in_block_hash": "string",
- "included_in_chunk_hash": "string",
- "index_in_chunk": 0,
- "nonce": 0,
- "receipt_conversion_gas_burnt": 0,
- "receipt_conversion_tokens_burnt": 0,
- "receiver_account_id": "string",
- "signature": "string",
- "signer_account_id": "string",
- "signer_public_key": "string",
- "status": "FAILURE",
- "transaction_hash": "string"
}NearIndexerController.getTransactions
Authorizations:
query Parameters
| contract | string |
| caller | string |
| limit | number |
| offset | number |
Responses
Response samples
- 200
[- {
- "method": "string",
- "args": { },
- "timestamp": 0,
- "receiptId": "string",
- "actionIndex": 0,
- "caller": "string",
- "contract": "string"
}
]NearIndexerController.getFunctionCalls
Authorizations:
path Parameters
| contract required | string |
query Parameters
| caller | string |
| limit | number |
| offset | number |
Responses
Response samples
- 200
[- {
- "method": "string",
- "args": { },
- "timestamp": 0,
- "receiptId": "string",
- "actionIndex": 0,
- "caller": "string",
- "contract": "string"
}
]NearIndexerController.getTransactionHistoryForToken
Authorizations:
path Parameters
| contract required | string |
| tokenId required | string |
query Parameters
| limit | number |
| offset | number |
Responses
Response samples
- 200
[- {
- "method": "string",
- "args": { },
- "timestamp": 0,
- "receiptId": "string",
- "actionIndex": 0,
- "caller": "string",
- "contract": "string"
}
]NearIndexerController.getTransactionHistoryForAccount
Authorizations:
path Parameters
| contract required | string |
| account required | string |
query Parameters
| limit | number |
| offset | number |
Responses
Response samples
- 200
[- {
- "method": "string",
- "args": { },
- "timestamp": 0,
- "receiptId": "string",
- "actionIndex": 0,
- "caller": "string",
- "contract": "string"
}
]NearNFTController.nearToEth
Authorizations:
header Parameters
| x-near-signature | string |
Request Body schema: application/json
| chainId | string |
| bridgeTokenContract required | string |
| sender required | string |
| recipient required | string |
| amount required | string <BigNumber> |
Responses
Request samples
- Payload
{- "chainId": "string",
- "bridgeTokenContract": "string",
- "sender": "string",
- "recipient": "string",
- "amount": "string"
}NearNFTController.accept
Authorizations:
header Parameters
| x-near-signature | string |
Request Body schema: application/json
| chainId | string |
| marketContract | string |
| tokenContract | string |
| tokenId | string |
| buyer | string |
object (TokenValue) | |
| seller | string |
Responses
Request samples
- Payload
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "buyer": "string",
- "price": {
- "ftContract": "string",
- "price": "string"
}, - "seller": "string"
}Response samples
- 200
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "seller": "string",
- "isAuction": true,
- "prices": [
- {
- "ftContract": "string",
- "price": "string"
}
]
}NearNFTController.buy
Authorizations:
header Parameters
| x-near-signature | string |
Request Body schema: application/json
| chainId | string |
| marketContract | string |
| tokenContract | string |
| tokenId | string |
| buyer | string |
object (TokenValue) |
Responses
Request samples
- Payload
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "buyer": "string",
- "price": {
- "ftContract": "string",
- "price": "string"
}
}Response samples
- 200
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "seller": "string",
- "isAuction": true,
- "prices": [
- {
- "ftContract": "string",
- "price": "string"
}
]
}NearNFTController.getSale
Authorizations:
Request Body schema: application/json
| chainId | string |
| marketContract | string |
| tokenContract | string |
| tokenId | string |
Responses
Request samples
- Payload
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string"
}Response samples
- 200
{- "nftContract": "string",
- "tokenId": "string",
- "tokenType": "string",
- "seller": "string",
- "conditions": [
- {
- "ftContract": "string",
- "price": "string"
}
], - "bids": [
- {
- "buyer": "string",
- "price": {
- "ftContract": "string",
- "price": "string"
}
}
], - "createdAt": "string"
}NearNFTController.removeSale
Authorizations:
header Parameters
| x-near-signature | string |
Request Body schema: application/json
| chainId | string |
| marketContract | string |
| tokenContract | string |
| tokenId | string |
| seller | string |
| isAuction | boolean |
Array of objects (TokenValue) |
Responses
Request samples
- Payload
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "seller": "string",
- "isAuction": true,
- "prices": [
- {
- "ftContract": "string",
- "price": "string"
}
]
}Response samples
- 200
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "seller": "string",
- "isAuction": true,
- "prices": [
- {
- "ftContract": "string",
- "price": "string"
}
]
}NearNFTController.sell
Authorizations:
header Parameters
| x-near-signature | string |
Request Body schema: application/json
| chainId | string |
| marketContract | string |
| tokenContract | string |
| tokenId | string |
| seller | string |
| isAuction | boolean |
Array of objects (TokenValue) |
Responses
Request samples
- Payload
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "seller": "string",
- "isAuction": true,
- "prices": [
- {
- "ftContract": "string",
- "price": "string"
}
]
}Response samples
- 200
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "seller": "string",
- "isAuction": true,
- "prices": [
- {
- "ftContract": "string",
- "price": "string"
}
]
}NearNFTController.updatePrice
Authorizations:
header Parameters
| x-near-signature | string |
Request Body schema: application/json
| chainId | string |
| marketContract | string |
| tokenContract | string |
| tokenId | string |
| seller | string |
| isAuction | boolean |
Array of objects (TokenValue) |
Responses
Request samples
- Payload
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "seller": "string",
- "isAuction": true,
- "prices": [
- {
- "ftContract": "string",
- "price": "string"
}
]
}Response samples
- 200
{- "chainId": "string",
- "marketContract": "string",
- "tokenContract": "string",
- "tokenId": "string",
- "seller": "string",
- "isAuction": true,
- "prices": [
- {
- "ftContract": "string",
- "price": "string"
}
]
}NearNFTController.getSaleByTokenId
Authorizations:
path Parameters
| marketContract required | string |
| tokenContract required | string |
| tokenId required | string |
Responses
Response samples
- 200
{- "nftContract": "string",
- "tokenId": "string",
- "tokenType": "string",
- "seller": "string",
- "conditions": [
- {
- "ftContract": "string",
- "price": "string"
}
], - "bids": [
- {
- "buyer": "string",
- "price": {
- "ftContract": "string",
- "price": "string"
}
}
], - "createdAt": "string"
}NearNFTController.getSalesByTokenContract
Authorizations:
path Parameters
| marketContract required | string |
| tokenContract required | string |
query Parameters
| offset | number |
| limit | number |
Responses
Response samples
- 200
[- {
- "nftContract": "string",
- "tokenId": "string",
- "tokenType": "string",
- "seller": "string",
- "conditions": [
- {
- "ftContract": "string",
- "price": "string"
}
], - "bids": [
- {
- "buyer": "string",
- "price": {
- "ftContract": "string",
- "price": "string"
}
}
], - "createdAt": "string"
}
]NearNFTController.getSales
Authorizations:
path Parameters
| marketContract required | string |
| indexName required | string Enum: "owner_id" "nft_contract_id" "nft_token_type" |
| indexKey required | string |
query Parameters
| offset | number |
| limit | number |
Responses
Response samples
- 200
[- {
- "nftContract": "string",
- "tokenId": "string",
- "tokenType": "string",
- "seller": "string",
- "conditions": [
- {
- "ftContract": "string",
- "price": "string"
}
], - "bids": [
- {
- "buyer": "string",
- "price": {
- "ftContract": "string",
- "price": "string"
}
}
], - "createdAt": "string"
}
]NearNFTController.getSalesBySeller
Authorizations:
path Parameters
| marketContract required | string |
| seller required | string |
query Parameters
| offset | number |
| limit | number |
Responses
Response samples
- 200
[- {
- "nftContract": "string",
- "tokenId": "string",
- "tokenType": "string",
- "seller": "string",
- "conditions": [
- {
- "ftContract": "string",
- "price": "string"
}
], - "bids": [
- {
- "buyer": "string",
- "price": {
- "ftContract": "string",
- "price": "string"
}
}
], - "createdAt": "string"
}
]NearNFTController.getSalesByTokenType
Authorizations:
path Parameters
| marketContract required | string |
| tokenType required | string |
query Parameters
| offset | number |
| limit | number |
Responses
Response samples
- 200
[- {
- "nftContract": "string",
- "tokenId": "string",
- "tokenType": "string",
- "seller": "string",
- "conditions": [
- {
- "ftContract": "string",
- "price": "string"
}
], - "bids": [
- {
- "buyer": "string",
- "price": {
- "ftContract": "string",
- "price": "string"
}
}
], - "createdAt": "string"
}
]NearNFTController.createMarketContract
Authorizations:
Request Body schema: application/json
| contractId | string |
| ftTokenIds | Array of strings |
| ownerAccount | string |
| chainId | string |
Responses
Request samples
- Payload
{- "contractId": "string",
- "ftTokenIds": [
- "string"
], - "ownerAccount": "string",
- "chainId": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}NearNFTController.getTokensByCollectionId
Authorizations:
path Parameters
| collectionId required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}
]
}NearNFTController.addTokenTypes
Authorizations:
path Parameters
| address required | string |
Request Body schema: application/json
Array of objects (NEP171TokenOption) | |
| locked | boolean |
Responses
Request samples
- Payload
{- "types": [
- {
- "type": "string",
- "cap": "string"
}
], - "locked": true
}NearNFTController.mintToken
Authorizations:
path Parameters
| address required | string Token contract address |
query Parameters
| receiverId | string Account that receives the token |
Request Body schema: application/json
| id | string |
| type | string |
| name | string |
| metadataUrl | string |
object (TokenProperties) | |
object (NEP171TokenMetadata) | |
| contractVersion | string |
Responses
Request samples
- Payload
{- "id": "string",
- "type": "string",
- "name": "string",
- "metadataUrl": "string",
- "properties": {
- "issuance": "string",
- "minting_fee": "string",
- "royalties": [
- {
- "value": "string",
- "address": "string",
- "label": "string"
}
]
}, - "metadata": {
- "title": "string",
- "description": "string",
- "media": "string",
- "media_hash": "string",
- "copies": "string",
- "issued_at": "string",
- "expires_at": "string",
- "starts_at": "string",
- "updated_at": "string",
- "extra": "string",
- "reference": "string",
- "reference_hash": "string"
}, - "contractVersion": "string"
}Response samples
- 200
{- "tokenId": "string",
- "transactionHash": "string"
}NearNFTController.getTokenContract
Authorizations:
path Parameters
| address required | string Token contract address |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}NearNFTController.createTokenContract
Authorizations:
Request Body schema: application/json
| name | string |
| metadataUrl | string |
Array of objects (NEP171TokenOption) | |
object (CollectionProperties) | |
object (NEP171ContractMetadata) | |
| owner | string |
| contractId | string NEAR account id for the NEP171 token contract |
Responses
Request samples
- Payload
{- "name": "string",
- "metadataUrl": "string",
- "tokenOptions": [
- {
- "type": "string",
- "cap": "string"
}
], - "properties": {
- "classification": "string",
- "series": {
- "publishDate": "string",
- "closeDate": "string"
}, - "tokensPerClaim": 0
}, - "metadata": {
- "spec": "string",
- "name": "string",
- "symbol": "string",
- "icon": "string",
- "base_uri": "string",
- "reference": "string",
- "reference_hash": "string"
}, - "owner": "string",
- "contractId": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}NearNFTController.transfer
Authorizations:
header Parameters
| x-near-signature | string |
Request Body schema: application/json
| tokenAddress | string |
| tokenId | string |
| sender | string |
| receiver | string |
| price | string <BigNumber> |
Responses
Request samples
- Payload
{- "tokenAddress": "string",
- "tokenId": "string",
- "sender": "string",
- "receiver": "string",
- "price": "string"
}Response samples
- 200
{- "chainId": "string",
- "tokenAddress": "string",
- "id": "string",
- "ownerAddress": "string",
- "tokenContract": {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}, - "metadata": {
- "title": "string",
- "description": "string",
- "media": "string",
- "media_hash": "string",
- "copies": "string",
- "issued_at": "string",
- "expires_at": "string",
- "starts_at": "string",
- "updated_at": "string",
- "extra": "string",
- "reference": "string",
- "reference_hash": "string"
}
}NearNFTController.getTokenById
Authorizations:
path Parameters
| address required | string Token contract address |
| id required | string Token id |
Responses
Response samples
- 200
{- "chainId": "string",
- "tokenAddress": "string",
- "id": "string",
- "ownerAddress": "string",
- "tokenContract": {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}, - "metadata": {
- "title": "string",
- "description": "string",
- "media": "string",
- "media_hash": "string",
- "copies": "string",
- "issued_at": "string",
- "expires_at": "string",
- "starts_at": "string",
- "updated_at": "string",
- "extra": "string",
- "reference": "string",
- "reference_hash": "string"
}
}NearNFTController.getTokens
Authorizations:
path Parameters
| address required | string Token contract address |
query Parameters
| limit | number Maximum number of items to be returned |
| paginationToken | string Pagination token from last query |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "chainId": "string",
- "tokenAddress": "string",
- "id": "string",
- "ownerAddress": "string",
- "tokenContract": {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}, - "metadata": {
- "title": "string",
- "description": "string",
- "media": "string",
- "media_hash": "string",
- "copies": "string",
- "issued_at": "string",
- "expires_at": "string",
- "starts_at": "string",
- "updated_at": "string",
- "extra": "string",
- "reference": "string",
- "reference_hash": "string"
}
}
]
}NearNFTController.getOwnedTokensByContract
Authorizations:
path Parameters
| userId required | string User account id |
| address required | string Token contract address |
query Parameters
| limit | number Maximum number of items to be returned |
| paginationToken | string Pagination token from last query |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}
]
}NearNFTController.getOwnedTokens
Authorizations:
path Parameters
| userId required | string User account id |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}
]
}NearNFTController.getCreatedTokenContracts
Authorizations:
path Parameters
| userId required | string User account id |
query Parameters
| limit | number Maximum number of items to be returned |
| paginationToken | string Pagination token from last query |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "type": "string",
- "chainId": "string",
- "name": "string",
- "symbol": "string",
- "tenant": "string",
- "metadataUrl": "string",
- "owner": "string",
- "transactionHash": "string",
- "tokenAddress": "string"
}
]
}NearNFTController.registerUser
Authorizations:
header Parameters
| x-near-signature | string |
Request Body schema: application/json
NEAT user account
| accountId | string |
| publicKey required | string |
| extraPublicKeys | Array of strings |
| signature | string |
Responses
Request samples
- Payload
{- "accountId": "string",
- "publicKey": "string",
- "extraPublicKeys": [
- "string"
], - "signature": "string"
}Response samples
- 200
{- "accountId": "string",
- "publicKey": "string",
- "extraPublicKeys": [
- "string"
], - "signature": "string"
}NFTMetadataController.createContractMetadata
Authorizations:
path Parameters
| chainId required | string |
| address required | string |
Request Body schema: application/json
| createdTime | string |
| pk | string |
| sk | string |
| classifier | string |
| classifierGroup | string |
| name | string |
| description | string |
| image | string |
| external_link | string |
| seller_fee_basis_points | number |
| fee_recipient | string |
Responses
Request samples
- Payload
{- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "image": "string",
- "external_link": "string",
- "seller_fee_basis_points": 0,
- "fee_recipient": "string"
}NFTMetadataController.getContractMetadata
Authorizations:
path Parameters
| chainId required | string |
| address required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "image": "string",
- "external_link": "string",
- "seller_fee_basis_points": 0,
- "fee_recipient": "string"
}NFTMetadataController.createTokenMetadata
Authorizations:
path Parameters
| chainId required | string |
| address required | string |
| id required | string |
Request Body schema: application/json
| createdTime | string |
| pk | string |
| sk | string |
| classifier | string |
| classifierGroup | string |
| name | string |
| description | string |
| image | string |
| contractAddress | string |
| transactionHash | string |
| tokenId | string <BigNumber> |
| decimals | number |
object |
Responses
Request samples
- Payload
{- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "image": "string",
- "contractAddress": "string",
- "transactionHash": "string",
- "tokenId": "string",
- "decimals": 0,
- "properties": { }
}NFTMetadataController.getTokenMetadata
Authorizations:
path Parameters
| chainId required | string |
| address required | string |
| id required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "image": "string",
- "contractAddress": "string",
- "transactionHash": "string",
- "tokenId": "string",
- "decimals": 0,
- "properties": { }
}RedditController.addCommunityConfig
Authorizations:
Request Body schema: application/json
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "clientId": "string",
- "communityName": "string"
}RedditController.isCommunityConfigSet
Authorizations:
query Parameters
| communityId required | string |
Responses
Response samples
- 200
{- "subredditId": "string",
- "subredditName": "string",
- "botTokenStatus": "string",
- "message": "string",
- "errors": [
- [
- "string"
]
]
}RoleManagerController.checkCommunityRoles
Authorizations:
Request Body schema: application/json
| communityId required | string Community id |
| userId | string User id. Set to "*" for all members. |
| delay | number Delay in seconds |
Responses
Request samples
- Payload
{- "communityId": "string",
- "userId": "string",
- "delay": 0
}Response samples
- 200
{- "communityId": "string",
- "userId": "string",
- "results": [
- {
- "consistent": true,
- "user": {
- "communityId": "string",
- "userId": "string",
- "memberId": "string",
- "guildId": "string",
- "communityName": "string",
- "communityIcon": "string"
}, - "roles": [
- {
- "id": "string",
- "name": "string",
- "current": true,
- "expected": true
}
], - "errors": [
- "string"
], - "rolesFailed": [
- "string"
], - "accounts": [
- "string"
], - "assets": [
- { }
], - "rules": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "scheme": "string",
- "roleId": "string",
- "asset": "string",
- "query": "string",
- "variables": { },
- "requiresMetadata": true
}
], - "currentRoles": [
- "string"
], - "rolesToApply": {
- "property1": true,
- "property2": true
}, - "resultsByRule": {
- "property1": true,
- "property2": true
}
}
]
}RoleManagerController.checkUserRoles
Authorizations:
Request Body schema: application/json
| communityId required | string Community id |
| userId | string User id. Set to "*" for all members. |
| delay | number Delay in seconds |
Responses
Request samples
- Payload
{- "communityId": "string",
- "userId": "string",
- "delay": 0
}Response samples
- 200
{- "communityId": "string",
- "userId": "string",
- "results": [
- {
- "consistent": true,
- "user": {
- "communityId": "string",
- "userId": "string",
- "memberId": "string",
- "guildId": "string",
- "communityName": "string",
- "communityIcon": "string"
}, - "roles": [
- {
- "id": "string",
- "name": "string",
- "current": true,
- "expected": true
}
], - "errors": [
- "string"
], - "rolesFailed": [
- "string"
], - "accounts": [
- "string"
], - "assets": [
- { }
], - "rules": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "scheme": "string",
- "roleId": "string",
- "asset": "string",
- "query": "string",
- "variables": { },
- "requiresMetadata": true
}
], - "currentRoles": [
- "string"
], - "rolesToApply": {
- "property1": true,
- "property2": true
}, - "resultsByRule": {
- "property1": true,
- "property2": true
}
}
]
}RoleManagerController.checkRoles
Authorizations:
query Parameters
| communityId | string |
| userId | string |
Responses
Response samples
- 200
{- "communityId": "string",
- "userId": "string",
- "results": [
- {
- "consistent": true,
- "user": {
- "communityId": "string",
- "userId": "string",
- "memberId": "string",
- "guildId": "string",
- "communityName": "string",
- "communityIcon": "string"
}, - "roles": [
- {
- "id": "string",
- "name": "string",
- "current": true,
- "expected": true
}
], - "errors": [
- "string"
], - "rolesFailed": [
- "string"
], - "accounts": [
- "string"
], - "assets": [
- { }
], - "rules": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "name": "string",
- "description": "string",
- "scheme": "string",
- "roleId": "string",
- "asset": "string",
- "query": "string",
- "variables": { },
- "requiresMetadata": true
}
], - "currentRoles": [
- "string"
], - "rolesToApply": {
- "property1": true,
- "property2": true
}, - "resultsByRule": {
- "property1": true,
- "property2": true
}
}
]
}RoleManagerController.schedule
Authorizations:
Request Body schema: application/json
| communityId required | string Community id |
| userId | string User id. Set to "*" for all members. |
| delay | number Delay in seconds |
Responses
Request samples
- Payload
{- "communityId": "string",
- "userId": "string",
- "delay": 0
}ScopesController.getScopesFromIds
Authorizations:
path Parameters
| ids required | string |
Responses
Response samples
- 200
{- "group": "string",
- "scopes": [
- {
- "id": "string",
- "group": "string",
- "description": "string",
- "endpoints": [
- {
- "controller": "string",
- "method": "string",
- "verb": "string",
- "path": "string",
- "tags": [
- "string"
]
}
]
}
], - "endpoints": [
- {
- "controller": "string",
- "method": "string",
- "verb": "string",
- "path": "string",
- "tags": [
- "string"
]
}
]
}ScopesController.getScope
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
{- "group": "string",
- "scopes": [
- {
- "id": "string",
- "group": "string",
- "description": "string",
- "endpoints": [
- {
- "controller": "string",
- "method": "string",
- "verb": "string",
- "path": "string",
- "tags": [
- "string"
]
}
]
}
], - "endpoints": [
- {
- "controller": "string",
- "method": "string",
- "verb": "string",
- "path": "string",
- "tags": [
- "string"
]
}
]
}ScopesController.getScopes
Authorizations:
Responses
Response samples
- 200
[- {
- "group": "string",
- "scopes": [
- {
- "id": "string",
- "group": "string",
- "description": "string",
- "endpoints": [
- {
- "controller": "string",
- "method": "string",
- "verb": "string",
- "path": "string",
- "tags": [
- "string"
]
}
]
}
], - "endpoints": [
- {
- "controller": "string",
- "method": "string",
- "verb": "string",
- "path": "string",
- "tags": [
- "string"
]
}
]
}
]UrlSlugController.createState
Authorizations:
Request Body schema: application/json
| property name* additional property | any |
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "url": "string",
- "slug": "string",
- "expiresAt": 0
}SnapshotController.updateSubscribedChannels
Authorizations:
path Parameters
| communityId required | string |
| space required | string |
Request Body schema: application/json
| channels | Array of strings |
Responses
Request samples
- Payload
{- "channels": [
- "string"
]
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "channels": [
- "string"
], - "space": "string"
}SnapshotController.subscribe
Authorizations:
path Parameters
| communityId required | string |
Request Body schema: application/json
| channels | Array of strings |
| space required | string |
Responses
Request samples
- Payload
{- "channels": [
- "string"
], - "space": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "channels": [
- "string"
], - "space": "string"
}SnapshotController.getSubscribedSpaces
Authorizations:
path Parameters
| communityId required | string |
Responses
Response samples
- 200
[- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "channels": [
- "string"
], - "space": "string"
}
]SnapshotWebhookController.subscribe
Authorizations:
header Parameters
| authentication | string |
Request Body schema: application/json
| id required | string |
| event required | string |
| space required | string |
| token required | string |
| secret required | string |
| expire required | number |
| property name* additional property | any |
Responses
Request samples
- Payload
{- "id": "string",
- "event": "string",
- "space": "string",
- "token": "string",
- "secret": "string",
- "expire": 0
}StakingContractsController.getStakingContracts
Authorizations:
Responses
Response samples
- 200
[- {
- "contractName": "string",
- "contractAddress": "string",
- "chainId": 0,
- "supportedAssets": [
- {
- "name": "string",
- "asset": "string"
}
]
}
]StripeController.generateDonationLink
Authorizations:
Request Body schema: application/json
| price required | number |
| recurring | boolean |
| confirmationMessage | string |
| redirectUri | string |
Responses
Request samples
- Payload
{- "price": 0,
- "recurring": true,
- "confirmationMessage": "string",
- "redirectUri": "string"
}Response samples
- 200
{- "url": "string"
}StripeController.generateStripeCheckoutURL
Authorizations:
path Parameters
| planId required | string |
Request Body schema: application/json
| state required | object |
| redirectUri | string |
Responses
Request samples
- Payload
{- "state": { },
- "redirectUri": "string"
}Response samples
- 200
{- "url": "string"
}TokenproofLoginController.getResponse
Authorizations:
path Parameters
| requestId required | string |
query Parameters
| retries | string |
Responses
Response samples
- 200
{- "nonce": "string",
- "status": "string",
- "account": "string",
- "reason": "string",
- "timestamp": "string",
- "session_id": "string"
}UnlockProtocolController.generateCheckoutURL
Authorizations:
path Parameters
| planId required | string |
Request Body schema: application/json
| state required | object |
| redirectUri | string |
Responses
Request samples
- Payload
{- "state": { },
- "redirectUri": "string"
}Response samples
- 200
{- "url": "string"
}UserAdsController.getQualifications
Authorizations:
query Parameters
| testnetEth | boolean A flag to check testnet ETH |
| arbEth | boolean A flag to test Arb ETH |
| arbArb | boolean A flag to test Arb ARB |
Responses
Response samples
- 200
{- "ownsTestnetEth": true,
- "ownsArbEth": true,
- "ownsArbArb": true
}UserAdsController.trackUserAd
Authorizations:
Request Body schema: application/json
Track ad impression/click events (frontend-driven)
| type required | string Enum: "impression" "click" |
| adType | string Default: "specify" Enum: "specify" "spindl" "in_house" |
| adId | string |
| impressionId | string |
| campaignId | string |
| imageFormat | string |
| adUnitId | string |
| walletAddress | string |
| metadata | object |
| communityId | string |
Responses
Request samples
- Payload
{- "type": "impression",
- "adType": "specify",
- "adId": "string",
- "impressionId": "string",
- "campaignId": "string",
- "imageFormat": "string",
- "adUnitId": "string",
- "walletAddress": "string",
- "metadata": { },
- "communityId": "string"
}UserAuthorizationController.createUserAuthorization
Authorizations:
path Parameters
| slug required | string |
Request Body schema: application/json
| rememberDecisions | boolean |
| scopes | Array of strings |
Responses
Request samples
- Payload
{- "rememberDecisions": true,
- "scopes": [
- "string"
]
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "clientApplicationId": "string",
- "scopes": [
- "string"
]
}UserAuthorizationController.getUserAuthorizationByClientId
Authorizations:
path Parameters
| clientId required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "clientApplicationId": "string",
- "scopes": [
- "string"
]
}UserAuthorizationController.getUserAuthorizations
Authorizations:
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "clientApplicationId": "string",
- "scopes": [
- "string"
]
}
]
}WalletManagerController.generateMagicCode
Authorizations:
Request Body schema: application/json
| marketplace required | string Name of the marketplace |
| account required | string Wallet address or user name with the marketplace |
| id required | string AE token for the Discord user |
Responses
Request samples
- Payload
{- "marketplace": "string",
- "account": "string",
- "id": "string"
}Response samples
- 200
{- "magicCode": "string",
- "expiresAt": "string"
}WalletManagerController.connectMarketplaceWallet
Authorizations:
Request Body schema: application/json
| marketplace required | string Name of the marketplace |
| account required | string Wallet address or user name with the marketplace |
| id | string AE token for the Discord user |
| magicCode | string A unique code to set to the user's marketplace profile |
| proof | string A proof from the user |
Responses
Request samples
- Payload
{- "marketplace": "string",
- "account": "string",
- "id": "string",
- "magicCode": "string",
- "proof": "string"
}Response samples
- 200
{- "success": true,
- "address": "string",
- "proxies": [
- {
- "proxyAddresses": [
- "string"
], - "proxyAccounts": [
- "string"
], - "proxyType": "string"
}
], - "state": "string",
- "message": "string",
- "code": "string",
- "resetToken": "string",
- "connection": {
- "user": {
- "platform": "string",
- "id": "string",
- "userPk": "string",
- "name": "string",
- "communityId": "string",
- "communityPk": "string",
- "communityName": "string",
- "state": "string",
- "message": "string"
}, - "walletType": "string",
- "address": "string",
- "accountId": "string"
}
}WalletManagerController.disconnectWallets
Authorizations:
Request Body schema: application/json
| walletSk required | Array of strings Array of wallet ids (sk) |
| id | string Request id |
Responses
Request samples
- Payload
{- "walletSk": [
- "string"
], - "id": "string"
}Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "address": "string",
- "signerAddress": "string",
- "contract": "string",
- "accountId": "string",
- "userId": "string",
- "platform": "string",
- "communityId": "string",
- "communityPk": "string",
- "walletType": "string",
- "metadata": {
- "property1": true,
- "property2": true
}
}
]
}WalletManagerController.resumeWalletConnection
Authorizations:
Request Body schema: application/json
| proxyAddress | string |
| state | string |
| address | string |
Responses
Request samples
- Payload
{- "proxyAddress": "string",
- "state": "string",
- "address": "string"
}WalletManagerController.resumeCircleWalletConnection
Authorizations:
Request Body schema: application/json
| proxyAddress | string |
| state | string |
| address | string |
Responses
Request samples
- Payload
{- "proxyAddress": "string",
- "state": "string",
- "address": "string"
}WalletManagerController.disconnectWallet
Authorizations:
path Parameters
| walletSk required | string Wallet id (sk) |
query Parameters
| id | string Request id |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "address": "string",
- "signerAddress": "string",
- "contract": "string",
- "accountId": "string",
- "userId": "string",
- "platform": "string",
- "communityId": "string",
- "communityPk": "string",
- "walletType": "string",
- "metadata": {
- "property1": true,
- "property2": true
}
}
]
}WalletManagerController.connectWallet
Authorizations:
Request Body schema: application/json
| walletSk required | string Wallet connection sk |
| platform | string |
| communityId required | string Community id |
| id required | string AE token to represent a community user that requests wallet connection |
Responses
Request samples
- Payload
{- "walletSk": "string",
- "platform": "string",
- "communityId": "string",
- "id": "string"
}Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "address": "string",
- "signerAddress": "string",
- "contract": "string",
- "accountId": "string",
- "userId": "string",
- "platform": "string",
- "communityId": "string",
- "communityPk": "string",
- "walletType": "string",
- "metadata": {
- "property1": true,
- "property2": true
}
}WalletManagerController.getWallets
Authorizations:
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "address": "string",
- "signerAddress": "string",
- "contract": "string",
- "accountId": "string",
- "userId": "string",
- "platform": "string",
- "communityId": "string",
- "communityPk": "string",
- "walletType": "string",
- "metadata": {
- "property1": true,
- "property2": true
}
}
]
}WebauthnController.verifyAuthenticationResponse
Authorizations:
Request Body schema: application/json
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "verified": true,
- "idToken": "string"
}WebauthnController.renameCredential
Authorizations:
path Parameters
| id required | string |
Request Body schema: application/json
| name required | string |
Responses
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{ }WebauthnController.getCredential
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
{- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "rpID": "string",
- "name": "string",
- "credentialPublicKey": "string",
- "credentialDeviceType": "string",
- "authenticatorAttachment": "string",
- "credentialID": "string",
- "devicePublicKey": "string",
- "counter": 0,
- "transports": [
- "string"
], - "clientExtensionResults": {
- "appid": true,
- "credProps": {
- "rk": true
}, - "hmacCreateSecret": true
}, - "userVerified": true,
- "userAgent": "string"
}WebauthnController.getCredentials
Authorizations:
query Parameters
| rpId | string |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "paginationToken": "string",
- "items": [
- {
- "id": "string",
- "createdTime": "string",
- "pk": "string",
- "sk": "string",
- "classifier": "string",
- "classifierGroup": "string",
- "rpID": "string",
- "name": "string",
- "credentialPublicKey": "string",
- "credentialDeviceType": "string",
- "authenticatorAttachment": "string",
- "credentialID": "string",
- "devicePublicKey": "string",
- "counter": 0,
- "transports": [
- "string"
], - "clientExtensionResults": {
- "appid": true,
- "credProps": {
- "rk": true
}, - "hmacCreateSecret": true
}, - "userVerified": true,
- "userAgent": "string"
}
]
}