Tenant User - Get Tenant Details
GET /v1/tenants/:tenantId
Tenant User - Get Tenant Details
Path Parameters
- tenantId string required
- 200
Tenant fetched successfully
- application/json
- Schema
- Example (from schema)
Schema
- status number required
- message string required
data object required
name string requiredplanId string requiredexternalId string requiredexternalApiKeys object required
steamApiKey stringpinataJWTKey stringopenaiApiKey stringmoonstreamApiKey stringmoonstreamLeaderboardId stringpaymasterContracts object[]
Array [contractAbicontractAddress string requiredtype string requiredownedBy string requiredPossible values: [
tenant
,developer
]Default value:
tenant
status string requiredPossible values: [
ACTIVE
,INACTIVE
]Default value:
INACTIVE
networkName string requiredchainId number requiredPossible values:
> 0
rpcUrl uri requiredcurrency string requiredblockExplorerBaseUrl string requiredprivateKey stringpublicKey string requiredpaymasterAddresses string[]fakeContractAddress stringexplorerUrl string requiredname stringtenantName stringPossible values: [
Game7
,zkSync
,HyperPlay
,Summon
,ETHDenver
,IronWorks
]tenantId stringtemplateId stringcreatedAt stringnull requiredupdatedAt stringnull requiredrules object[]
Array [ruleId string requiredname string requiredfunctionNames string[] requiredPossible values:
>= 1
requirements object required
functionCallAmount numberfunctionCallTimeRestriction stringallowedTokens string[]status string requiredPossible values: [
ACTIVE
,INACTIVE
]]salt stringupgradable booleanproxyType stringPossible values: [
EIP2535
,TransparentUpgradeableProxy
,EIP1967
]proxy object
abiaddress string requiredowner string requiredproxyAdmin object
abiaddress string requiredowner string requiredimplementation object
address string requiredabiextensions object[]
Array [abiaddress string requiredfunctions object[] required
Array [functionSelector string requiredfunctionSignature string required]]]web3Storages object[]
Array [cid string requiredname string requiredactive boolean required]permissions object required
badge integerPossible values: [
100
,200
,300
]item integerPossible values: [
100
,200
,300
]contract integerPossible values: [
100
,200
,300
]level integerPossible values: [
100
,200
,300
]user integerPossible values: [
100
,200
,300
]tenant integerPossible values: [
100
,200
,300
]transfer integerPossible values: [
100
,200
,300
]pinata integerPossible values: [
100
,200
,300
]randomness integerPossible values: [
100
,200
,300
]ai integerPossible values: [
100
,200
,300
]moonstream integerPossible values: [
100
,200
,300
]nftgating integerPossible values: [
100
,200
,300
]gamesummary integerPossible values: [
100
,200
,300
]security integerPossible values: [
100
,200
,300
]steam integerPossible values: [
100
,200
,300
]paymaster integerPossible values: [
100
,200
,300
]roles object[] required
Array [name string requiredPossible values: [
admin
,super_admin
,manager
,customer
,teammate
]permissions object required
badge integerPossible values: [
100
,200
,300
]item integerPossible values: [
100
,200
,300
]contract integerPossible values: [
100
,200
,300
]level integerPossible values: [
100
,200
,300
]user integerPossible values: [
100
,200
,300
]tenant integerPossible values: [
100
,200
,300
]transfer integerPossible values: [
100
,200
,300
]pinata integerPossible values: [
100
,200
,300
]randomness integerPossible values: [
100
,200
,300
]ai integerPossible values: [
100
,200
,300
]moonstream integerPossible values: [
100
,200
,300
]nftgating integerPossible values: [
100
,200
,300
]gamesummary integerPossible values: [
100
,200
,300
]security integerPossible values: [
100
,200
,300
]steam integerPossible values: [
100
,200
,300
]paymaster integerPossible values: [
100
,200
,300
]]isSubTenant booleanparentTenant stringdefaultConfig object
defaultPrivateKey string requireddefaultPublicKey string requireddefaultCurrency string requireddefaultChainId number requireddefaultRpcUrl string requireddefaultNetworkName string requireddefaultBlockExplorerBaseUrl string requiredisMainnet boolean requiredrandomnessConfig object
tiers object required
0 number required1 number required2 number required3 number required4 number required5 number required6 number required7 number requiredmaxTierPercentage number requiredminTierPercentage number requiredexcludes object
collections string[] requiredcategories string[] requiredstatus string requiredPossible values: [
ACTIVE
,INACTIVE
]createdAt string requiredupdatedAt string required
{
"status": 0,
"message": "string",
"data": {
"name": "string",
"planId": "string",
"externalId": "string",
"externalApiKeys": {
"steamApiKey": "string",
"pinataJWTKey": "string",
"openaiApiKey": "string",
"moonstreamApiKey": "string",
"moonstreamLeaderboardId": "string"
},
"paymasterContracts": [
{
"contractAbi": {},
"contractAddress": "string",
"type": "string",
"ownedBy": "tenant",
"status": "INACTIVE",
"networkName": "string",
"chainId": 0,
"rpcUrl": "string",
"currency": "string",
"blockExplorerBaseUrl": "string",
"privateKey": "string",
"publicKey": "string",
"paymasterAddresses": [
"string"
],
"fakeContractAddress": "string",
"explorerUrl": "string",
"name": "string",
"tenantName": "Game7",
"tenantId": "string",
"templateId": "string",
"rules": [
{
"ruleId": "string",
"name": "string",
"functionNames": [
"string"
],
"requirements": {
"functionCallAmount": 0,
"functionCallTimeRestriction": "string",
"allowedTokens": [
"string"
],
"status": "ACTIVE"
}
}
],
"salt": "string",
"upgradable": true,
"proxyType": "EIP2535",
"proxy": {
"abi": {},
"address": "string",
"owner": "string"
},
"proxyAdmin": {
"abi": {},
"address": "string",
"owner": "string"
},
"implementation": {
"address": "string",
"abi": {}
},
"extensions": [
{
"abi": {},
"address": "string",
"functions": [
{
"functionSelector": "string",
"functionSignature": "string"
}
]
}
]
}
],
"web3Storages": [
{
"cid": "string",
"name": "string",
"active": true
}
],
"permissions": {
"badge": 100,
"item": 100,
"contract": 100,
"level": 100,
"user": 100,
"tenant": 100,
"transfer": 100,
"pinata": 100,
"randomness": 100,
"ai": 100,
"moonstream": 100,
"nftgating": 100,
"gamesummary": 100,
"security": 100,
"steam": 100,
"paymaster": 100
},
"roles": [
{
"name": "admin",
"permissions": {
"badge": 100,
"item": 100,
"contract": 100,
"level": 100,
"user": 100,
"tenant": 100,
"transfer": 100,
"pinata": 100,
"randomness": 100,
"ai": 100,
"moonstream": 100,
"nftgating": 100,
"gamesummary": 100,
"security": 100,
"steam": 100,
"paymaster": 100
}
}
],
"isSubTenant": true,
"parentTenant": "string",
"defaultConfig": {
"defaultPrivateKey": "string",
"defaultPublicKey": "string",
"defaultCurrency": "string",
"defaultChainId": 0,
"defaultRpcUrl": "string",
"defaultNetworkName": "string",
"defaultBlockExplorerBaseUrl": "string",
"isMainnet": true
},
"randomnessConfig": {
"tiers": {
"0": 0,
"1": 0,
"2": 0,
"3": 0,
"4": 0,
"5": 0,
"6": 0,
"7": 0
},
"maxTierPercentage": 0,
"minTierPercentage": 0,
"excludes": {
"collections": [
"string"
],
"categories": [
"string"
]
}
},
"status": "ACTIVE",
"createdAt": "string",
"updatedAt": "string"
}
}