Skip to content

See your household's members, their devices and what was blocked this week

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/household
curl --request GET \  --url https://api.xovris.ai/v1/household \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
members
required
Array<object>
object
version
required
number
removed
required
boolean
devices
required
Array<object>
object
id
required
string
label
required
string
os
required
string
createdAt
required
string
lastUsedOn
required
One of:
string
on
required
boolean
lastSevenDays
required
One of:
object
member_id
required
string
blocked
required
number
rewritten
required
number
answered
required
number
refused
required
number
block
Array<string>
allow
Array<string>
services
Array<string>
quiet
Array<object>
object
days
required
Array<number>
from
required
string
to
required
string
why
required
string
Allowed values: bedtime homework family_time
id
required
string
name
required
string
band
required
string
bandWords
required
string
timeZone
required
string
services
required
Array<object>
object
key
required
string
name
required
string
bands
required
Array<object>
object
band
required
string
Allowed values: child young_child teen adult guest
words
required
string
locked
required
One of:
object
feature
required
string
Allowed values: home_network.security
plan
required
One of:
string
message
required
string
next
required
string

Example

{  "members": [    {      "version": 1,      "removed": true,      "devices": [        {          "id": "string",          "label": "string",          "os": "string",          "createdAt": "string",          "lastUsedOn": "string",          "on": true        }      ],      "lastSevenDays": {        "member_id": "string",        "blocked": 1,        "rewritten": 1,        "answered": 1,        "refused": 1      },      "block": [        "string"      ],      "allow": [        "string"      ],      "services": [        "string"      ],      "quiet": [        {          "days": [            1          ],          "from": "string",          "to": "string",          "why": "bedtime"        }      ],      "id": "string",      "name": "string",      "band": "string",      "bandWords": "string",      "timeZone": "string"    }  ],  "services": [    {      "key": "string",      "name": "string"    }  ],  "bands": [    {      "band": "child",      "words": "string"    }  ],  "locked": {    "feature": "home_network.security",    "plan": "string",    "message": "string",    "next": "string"  }}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.