One home: device, parents, members; for the root admin also open invites, limits and sync status.
Parameters
Output
application/jsoncreatedAt
stringdatetime
Optional
An RFC 3339 formatted timestamp.
device
refai.newnal.illi.home.defs#deviceView
Optional
No description available.
homeId
stringtid
Required
A timestamp-based identifier (TID).
invites
array
Optional
No description available.
limits
refai.newnal.illi.home.defs#limits
Optional
No description available.
members
array
Required
No description available.
name
string
Required
No description available.
parents
array
Required
No description available.
role
string
Required
No description available.
rootAdminDid
stringdid
Required
A decentralized identifier (DID).
sphere
string
Required
No description available.
sync
refai.newnal.illi.home.defs#syncView
Optional
No description available.
Errors
HomeNotFound
NotMember
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "One home: device, parents, members; for the root admin also open invites, limits and sync status.",
"errors": [
{
"name": "HomeNotFound"
},
{
"name": "NotMember"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"createdAt": {
"format": "datetime",
"type": "string"
},
"device": {
"ref": "ai.newnal.illi.home.defs#deviceView",
"type": "ref"
},
"homeId": {
"format": "tid",
"type": "string"
},
"invites": {
"items": {
"ref": "ai.newnal.illi.home.defs#inviteView",
"type": "ref"
},
"type": "array"
},
"limits": {
"ref": "ai.newnal.illi.home.defs#limits",
"type": "ref"
},
"members": {
"items": {
"ref": "ai.newnal.illi.home.defs#memberView",
"type": "ref"
},
"type": "array"
},
"name": {
"type": "string"
},
"parents": {
"items": {
"ref": "ai.newnal.illi.home.defs#parentView",
"type": "ref"
},
"type": "array"
},
"role": {
"type": "string"
},
"rootAdminDid": {
"format": "did",
"type": "string"
},
"sphere": {
"type": "string"
},
"sync": {
"ref": "ai.newnal.illi.home.defs#syncView",
"type": "ref"
}
},
"required": [
"homeId",
"name",
"role",
"rootAdminDid",
"sphere",
"parents",
"members"
],
"type": "object"
}
},
"parameters": {
"properties": {
"homeId": {
"format": "tid",
"type": "string"
}
},
"required": [
"homeId"
],
"type": "params"
},
"type": "query"
}