Skip to main content
Documentation Powered by Redocly

CollabLand API Server (0.73.0)

Download OpenAPI specification:Download

JwksController

JwksController.getJwks

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

AccessControlController

AccessControlController.getCheckRolesResponse

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
requestId
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "roles": [
    ],
  • "errors": [
    ]
}

AccessControlController.checkRoles

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
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

Content type
application/json
{
  • "account": "string",
  • "rules": [
    ],
  • "callbackUrl": "string",
  • "async": true
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "roles": [
    ],
  • "errors": [
    ]
}

AccessControlController.getRoles

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
communityId
required
string
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "roles": [
    ],
  • "errors": [
    ]
}

AccountController

AccountController.getAdministratedCommunities

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "paginationToken": "string",
  • "items": [
    ]
}

AccountController.getAuthChallenge

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

AccountController.getAuthToken

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
query Parameters
ttl
number
clientId
string
scope
string

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "ttl": 0,
  • "clientId": "string",
  • "scopes": [
    ]
}

AccountController.getBalances

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AccountController.getUserCommunities

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "paginationToken": "string",
  • "items": [
    ]
}

AccountController.getDropWallet

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "accounts": [
    ]
}

AccountController.findLinkedUsers

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

AccountController.logout

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

AccountController.logoutGet

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

AccountController.getUserProfile

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdTime": "string",
  • "pk": "string",
  • "sk": "string",
  • "classifier": "string",
  • "classifierGroup": "string",
  • "platform": "string",
  • "userName": "string"
}

AccountController.addWalletAddress

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json
chainId
string
address
required
string
message
required
string
signedMessage
required
string

Responses

Request samples

Content type
application/json
{
  • "chainId": "string",
  • "address": "string",
  • "message": "string",
  • "signedMessage": "string"
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "accounts": [
    ]
}

AccountController.deleteWallet

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
address
required
string

Responses

AccountController.getWallets

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
query Parameters
limit
number
paginationToken
string

Responses

Response samples

Content type
application/json
{
  • "paginationToken": "string",
  • "items": [
    ]
}

AccountController.deleteWallets

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

KChannelAccountController

KChannelAccountController.setupCustodialPaymentChannel

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json

Channel addresses

deposit_address
string
sender_address_list
Array of strings

Responses

Request samples

Content type
application/json
{
  • "deposit_address": "string",
  • "sender_address_list": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdTime": "string",
  • "pk": "string",
  • "sk": "string",
  • "classifier": "string",
  • "classifierGroup": "string",
  • "channel_uuid": "string",
  • "user_id": "string",
  • "definition_version": "string",
  • "channel_rating_id": "string",
  • "zone_address": "string",
  • "owner_address": "string",
  • "deposit_address": "string",
  • "validator_address": "string",
  • "sender_address_list": [
    ],
  • "device_address_list": [
    ],
  • "initial_state_hash": "string",
  • "signature_list": [
    ],
  • "encrypted_wallet_private_key": "string",
  • "zone_location": {
    }
}

KChannelAccountController.abandonTransaction

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

KChannelAccountController.getPaymentChannelBalance

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "accounts": [
    ]
}

KChannelAccountController.createWithdrawal

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json
recipientAddress
required
string
value
required
string <BigNumber>
tokenAddress
string
chainId
string
forceOnChain
boolean
deductFee
boolean

Responses

Request samples

Content type
application/json
{
  • "recipientAddress": "string",
  • "value": "string",
  • "tokenAddress": "string",
  • "chainId": "string",
  • "forceOnChain": true,
  • "deductFee": true
}

Response samples

Content type
application/json
{
  • "request_uuid": "string",
  • "reference_data": "string",
  • "value_list": [
    ],
  • "sender_party": {
    },
  • "recipient_party": {
    },
  • "signature_list": [
    ],
  • "metadata": {
    }
}

KChannelAccountController.failTransaction

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json
request_uuid
string
channel_uuid
string
definition_version
string
client_signer_address
string
zone_signer_address
string
final_state_hash
string
external_tx_reference
string
recipient_address
string
peer_last_seen_state_hash
string
timestamp
string
Array of objects (ChannelTransactionValue)
signature_list
Array of strings

Responses

Request samples

Content type
application/json
{
  • "request_uuid": "string",
  • "channel_uuid": "string",
  • "definition_version": "string",
  • "client_signer_address": "string",
  • "zone_signer_address": "string",
  • "final_state_hash": "string",
  • "external_tx_reference": "string",
  • "recipient_address": "string",
  • "peer_last_seen_state_hash": "string",
  • "timestamp": "string",
  • "value_list": [
    ],
  • "signature_list": [
    ]
}

Response samples

Content type
application/json
{
  • "request_uuid": "string",
  • "channel_uuid": "string",
  • "definition_version": "string",
  • "client_signer_address": "string",
  • "zone_signer_address": "string",
  • "final_state_hash": "string",
  • "external_tx_reference": "string",
  • "recipient_address": "string",
  • "peer_last_seen_state_hash": "string",
  • "timestamp": "string",
  • "value_list": [
    ],
  • "signature_list": [
    ]
}

KChannelAccountController.submitTransaction

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json
request_uuid
string
reference_data
string
Array of objects (ChannelTransactionValue)
object (ChannelTransactionParty)
object (ChannelTransactionParty)
signature_list
Array of strings
object (ChannelTransactionMetadata)

Responses

Request samples

Content type
application/json
{
  • "request_uuid": "string",
  • "reference_data": "string",
  • "value_list": [
    ],
  • "sender_party": {
    },
  • "recipient_party": {
    },
  • "signature_list": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string"
}

KChannelAccountController.submitWithdrawal

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json
request_uuid
string
reference_data
string
Array of objects (ChannelTransactionValue)
object (ChannelTransactionParty)
object (ChannelTransactionParty)
signature_list
Array of strings
object (ChannelTransactionMetadata)

Responses

Request samples

Content type
application/json
{
  • "request_uuid": "string",
  • "reference_data": "string",
  • "value_list": [
    ],
  • "sender_party": {
    },
  • "recipient_party": {
    },
  • "signature_list": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "transactionId": "string"
}

KChannelAccountController.getPaymentChannelTokens

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

KChannelAccountController.transferTo

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json
from
string
to
required
Array of strings
value
required
string <BigNumber>
tokenAddress
string
chainId
string

Responses

Request samples

Content type
application/json
{
  • "from": "string",
  • "to": [
    ],
  • "value": "string",
  • "tokenAddress": "string",
  • "chainId": "string"
}

Response samples

Content type
application/json
{
  • "statuses": [
    ]
}

KChannelAccountController.withdraw

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json
recipientAddress
required
string
value
required
string <BigNumber>
tokenAddress
string
chainId
string
forceOnChain
boolean
deductFee
boolean

Responses

Request samples

Content type
application/json
{
  • "recipientAddress": "string",
  • "value": "string",
  • "tokenAddress": "string",
  • "chainId": "string",
  • "forceOnChain": true,
  • "deductFee": true
}

Response samples

Content type
application/json
{
  • "status": "string"
}

KChannelAccountController.getPaymentChannelInfo

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
query Parameters
auth_token
string

Responses

Response samples

Content type
application/json
{
  • "info": {
    },
  • "definition": {
    },
  • "smartContract": "string"
}

KChannelAccountController.setupPaymentWallet

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "paymentWallet": {
    },
  • "webhookHeaders": {
    }
}

AssetOwnershipController

AssetOwnershipController.getAssets

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
account
required
string
query Parameters
assets
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AssetOwnershipController.getOwnership

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
account
required
string
query Parameters
assets
Array of strings

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ]
}

AssetOwnershipController.verifyOwnership

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "signature": "string",
  • "claim": {
    }
}

AssetOwnershipController.generateJWT

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
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

Content type
application/json
{
  • "classifier": "string",
  • "classifierGroup": "string",
  • "userId": "string",
  • "socialId": "string",
  • "openseaUrl": "string",
  • "mediaUrl": "string",
  • "account": "string",
  • "assets": [
    ]
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "slug": "string",
  • "url": "string"
}

NftDropController

NftDropController.claimNFT

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
Request Body schema: application/json
toAddress
required
string

The address to receive the NFT

waitForConfirmations
number

Number of confirmations to wait for the transaction

timeout
number

Number of seconds to wait before timeout

Responses

Request samples

Content type
application/json
{
  • "toAddress": "string",
  • "waitForConfirmations": 0,
  • "timeout": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdTime": "string",
  • "pk": "string",
  • "sk": "string",
  • "classifier": "string",
  • "classifierGroup": "string",
  • "userId": "string",
  • "address": "string",
  • "transactionHash": "string",
  • "tokenId": "string",
  • "tokenUri": "string",
  • "status": "string",
  • "error": { },
  • "urls": {
    }
}

NftDropController.getUserInfo

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "eligible": true,
  • "claimedDate": "string",
  • "cutoffDate": "string",
  • "member": { },
  • "wallets": [
    ],
  • "claimedNfts": [
    ]
}

MiniAppController

MiniAppController.installMiniApp

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
communityId
required
string
appId
required
string

Responses

Response samples

Content type
application/json
{
  • "appId": "string",
  • "developer": "string",
  • "name": "string",
  • "shortName": "string",
  • "supportedEnvs": [
    ],
  • "releasedDate": 0,
  • "version": {
    },
  • "keywords": [
    ],
  • "tags": [
    ],
  • "category": "string",
  • "website": "string",
  • "shortDescription": "string",
  • "description": "string",
  • "thumbnails": [
    ],
  • "icons": [
    ],
  • "platforms": [
    ],
  • "type": "string",
  • "price": 0,
  • "subscribedEvents": [
    ],
  • "webhookUrl": "string"
}

MiniAppController.uninstallMiniApp

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
communityId
required
string
appId
required
string

Responses

MiniAppController.getMiniAppsForCommunity

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
communityId
required
string
query Parameters
installedOnly
boolean

Responses

Response samples

Content type
application/json
{
  • "appId": "string",
  • "developer": "string",
  • "name": "string",
  • "shortName": "string",
  • "supportedEnvs": [
    ],
  • "releasedDate": 0,
  • "version": {
    },
  • "keywords": [
    ],
  • "tags": [
    ],
  • "category": "string",
  • "website": "string",
  • "shortDescription": "string",
  • "description": "string",
  • "thumbnails": [
    ],
  • "icons": [
    ],
  • "platforms": [
    ],
  • "type": "string",
  • "price": 0,
  • "subscribedEvents": [
    ],
  • "webhookUrl": "string"
}

CommunityController

CommunityController.getStats

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "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:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
communityId
required
string

Responses

Response samples

Content type
application/json
{
  • "paginationToken": "string",
  • "items": [
    ]
}

CommunityController.replaceTpc

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
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
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

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "createdTime": "string",
  • "sk": "string",
  • "classifier": "string",
  • "classifierGroup": "string",
  • "name": "string",
  • "description": "string",
  • "roleId": "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"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

CommunityController.deleteTpc

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
id
required
string
tpcId
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

CommunityController.createTpc

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
id
required
string
Request Body schema: application/json
createdTime
string
classifierGroup
string
name
string
description
string
roleId
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

Responses

Request samples

Content type
application/json
{
  • "createdTime": "string",
  • "classifierGroup": "string",
  • "name": "string",
  • "description": "string",
  • "roleId": "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"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdTime": "string",
  • "pk": "string",
  • "sk": "string",
  • "classifier": "string",
  • "classifierGroup": "string",
  • "name": "string",
  • "description": "string",
  • "roleId": "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"
}

CommunityController.findTpcs

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
id
required
string
query Parameters
limit
number
paginationToken
string

Responses

Response samples

Content type
application/json
{
  • "paginationToken": "string",
  • "items": [
    ]
}

CommunityController.replaceById

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
id
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "error": {
    }
}

CommunityController.updateById

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
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
iconURL
string
inviteLink
string
Array of objects (Channel)
Array of objects (Quest)
Array of objects (Drop)
object (Stats)
Array of objects (TokenPermissionedChat)
property name*
additional property
any

Responses

Request samples

Content type
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",
  • "iconURL": "string",
  • "inviteLink": "string",
  • "channels": [
    ],
  • "quests": [
    ],
  • "drops": [
    ],
  • "stats": {
    },
  • "tpcs": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

CommunityController.findById

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
id
required
string
query Parameters
include
string

Responses

Response samples

Content type
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",
  • "iconURL": "string",
  • "inviteLink": "string",
  • "channels": [
    ],
  • "quests": [
    ],
  • "drops": [
    ],
  • "stats": {
    },
  • "tpcs": [
    ]
}

CommunityController.deleteById

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

CommunityController.create

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
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
iconURL
string
inviteLink
string
Array of objects (Channel)
Array of objects (Quest)
Array of objects (Drop)
object (Stats)
Array of objects (TokenPermissionedChat)
property name*
additional property
any

Responses

Request samples

Content type
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",
  • "iconURL": "string",
  • "inviteLink": "string",
  • "channels": [
    ],
  • "quests": [
    ],
  • "drops": [
    ],
  • "stats": {
    },
  • "tpcs": [
    ]
}

Response samples

Content type
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",
  • "iconURL": "string",
  • "inviteLink": "string",
  • "channels": [
    ],
  • "quests": [
    ],
  • "drops": [
    ],
  • "stats": {
    },
  • "tpcs": [
    ]
}

CommunityController.find

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
query Parameters
limit
number
paginationToken
string
include
string

Responses

Response samples

Content type
application/json
{
  • "paginationToken": "string",
  • "items": [
    ]
}

CommunityWalletController

CommunityWalletController.createWallet

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
communityId
required
string

Responses

Response samples

Content type
application/json
{
  • "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:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
communityId
required
string

Responses

Response samples

Content type
application/json
{
  • "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

ConfigController.getConfig

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "jwtPublicKey": "string",
  • "discordClientId": "string",
  • "actionEcdsaPublicKey": "string",
  • "actionEd25519PublicKey": "string"
}

DevRequestController

DevRequestController.createClientAppRequest

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
organizationId
required
string
Request Body schema: application/json
description
required
string

Description of App for which this is requested

projectUrls
required
Array of strings
icon
string

Url of icon for the app

name
required
string

Name of the app.

url
string

Application url

redirectUris
Array of strings
allowedGrantTypes
Array of strings
clientType
string

oAuth2 client type

allowedOrigins
Array of strings
allowedReferrers
Array of strings
allowedIpAddresses
Array of strings
allowedScopes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "projectUrls": [
    ],
  • "icon": "string",
  • "name": "string",
  • "url": "string",
  • "redirectUris": [
    ],
  • "allowedGrantTypes": [
    ],
  • "clientType": "string",
  • "allowedOrigins": [
    ],
  • "allowedReferrers": [
    ],
  • "allowedIpAddresses": [
    ],
  • "allowedScopes": [
    ]
}

Response samples

Content type
application/json
{
  • "pk": "string",
  • "sk": "string",
  • "classifier": "string",
  • "organizationId": "string",
  • "createdById": "string",
  • "timestamp": 0,
  • "description": "string",
  • "projectUrls": [
    ],
  • "icon": "string",
  • "name": "string",
  • "url": "string",
  • "redirectUris": [
    ],
  • "allowedGrantTypes": [
    ],
  • "clientType": "string",
  • "allowedOrigins": [
    ],
  • "allowedReferrers": [
    ],
  • "allowedIpAddresses": [
    ],
  • "allowedScopes": [
    ]
}

DevRequestController.getClientAppRequests

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{
  • "pk": "string",
  • "sk": "string",
  • "classifier": "string",
  • "organizationId": "string",
  • "createdById": "string",
  • "timestamp": 0,
  • "description": "string",
  • "projectUrls": [
    ],
  • "icon": "string",
  • "name": "string",
  • "url": "string",
  • "redirectUris": [
    ],
  • "allowedGrantTypes": [
    ],
  • "clientType": "string",
  • "allowedOrigins": [
    ],
  • "allowedReferrers": [
    ],
  • "allowedIpAddresses": [
    ],
  • "allowedScopes": [
    ]
}

DevRequestController.createMiniAppRequest

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
organizationId
required
string
Request Body schema: application/json
description
required
string

Description of App for which this is requested

projectUrls
required
Array of strings
icon
string

Url of icon for the app

name
required
string

Name of the app.

type
string

Type as free, paid or subscription based

platforms
Array of strings
thumbnails
Array of objects
category
string

Category of the Mini App it can be bot_command or cc_extension.

keywords
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "projectUrls": [
    ],
  • "icon": "string",
  • "name": "string",
  • "type": "string",
  • "platforms": [
    ],
  • "thumbnails": [
    ],
  • "category": "string",
  • "keywords": [
    ]
}

Response samples

Content type
application/json
{
  • "pk": "string",
  • "sk": "string",
  • "classifier": "string",
  • "organizationId": "string",
  • "createdById": "string",
  • "timestamp": 0,
  • "description": "string",
  • "projectUrls": [
    ],
  • "icon": "string",
  • "name": "string",
  • "type": "string",
  • "platforms": [
    ],
  • "thumbnails": [
    ],
  • "category": "string",
  • "keywords": [
    ]
}

DevRequestController.getMiniAppRequests

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{
  • "pk": "string",
  • "sk": "string",
  • "classifier": "string",
  • "organizationId": "string",
  • "createdById": "string",
  • "timestamp": 0,
  • "description": "string",
  • "projectUrls": [
    ],
  • "icon": "string",
  • "name": "string",
  • "type": "string",
  • "platforms": [
    ],
  • "thumbnails": [
    ],
  • "category": "string",
  • "keywords": [
    ]
}

OrganizationWalletController

OrganizationWalletController.createWallet

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
orgId
required
string

Responses

Response samples

Content type
application/json
{
  • "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"
}

OrganizationWalletController.getWalletDetail

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
orgId
required
string

Responses

Response samples

Content type
application/json
{
  • "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"
}

OrganizationController

OrganizationController.getOrganization

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
orgId
required
string

Responses

Response samples

Content type
application/json
{
  • "pk": "string",
  • "sk": "string",
  • "name": "string",
  • "createdTime": 0,
  • "classifier": "string",
  • "userId": "string"
}

OrganizationController.createOrganization

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "pk": "string",
  • "sk": "string",
  • "name": "string",
  • "createdTime": 0,
  • "classifier": "string",
  • "userId": "string"
}

OrganizationController.getOrganizations

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

Response samples

Content type
application/json
{
  • "pk": "string",
  • "sk": "string",
  • "name": "string",
  • "createdTime": 0,
  • "classifier": "string",
  • "userId": "string"
}

DiscordBotController

DiscordBotController.checkBotConfig

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
communityId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "errors": [
    ]
}

DiscordBotController.getDiscordMembers

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)

Responses

DiscordIntegrationController

DiscordIntegrationController.getDiscordGuildMemberCount

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
guildId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "memberCount": 0,
  • "channels": [
    ],
  • "roles": [
    ]
}

DiscordIntegrationController.createDiscordRole

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
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

Content type
application/json
{
  • "name": "string",
  • "color": "string",
  • "hoist": true,
  • "position": 0,
  • "mentionable": true,
  • "permissions": 0
}

DiscordIntegrationController.getDiscordGuild

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
guildId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "memberCount": 0,
  • "channels": [
    ],
  • "roles": [
    ]
}

DiscordIntegrationController.sendDiscordMessage

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
guildId
required
string
channelId
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

DiscordIntegrationController.findChannels

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "paginationToken": "string",
  • "items": [
    ]
}

DiscordIntegrationController.getMemberInfo

Authorizations:
(apiKeyauthenticatedEncryptionethereumcollabLandOAuth2)
path Parameters
guildId
required
string
memberId
required
string

Responses