Skip to content

Everyone working here said as one of the workspace's own people or from outside its domains, with the rule for outside people and any end their access carries

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/people/outside
curl --request GET \  --url https://api.xovris.ai/v1/people/outside \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
rule
required
object
home
required
Array<string>
invite
required
string
Allowed values: admins owners nobody anyone
inviters
required
Array<string>
only
required
Array<string>
never
required
Array<string>
maxDays
required
One of:
number
see
required
string
Allowed values: everyone themselves
leave
required
boolean
home
required
Array<string>
homeFrom
required
string
Allowed values: set owners
people
required
Array<object>
object
userId
required
string
email
required
string
name
required
One of:
string
role
required
string
Allowed values: admin billing owner member viewer custom
roleName
required
One of:
string
outside
required
boolean
endsAt
required
One of:
string
ended
required
boolean
invitations
required
Array<object>
object
id
required
string
email
required
string
role
required
string
Allowed values: admin billing owner member viewer custom
roleName
required
One of:
string
outside
required
boolean
endsAt
required
One of:
string
expiresAt
required
string
counts
required
object
own
required
number
outside
required
number
me
required
One of:
object
outside
required
boolean
mayLeave
required
boolean

Example

{  "rule": {    "home": [      "string"    ],    "invite": "admins",    "inviters": [      "string"    ],    "only": [      "string"    ],    "never": [      "string"    ],    "maxDays": 1,    "see": "everyone",    "leave": true  },  "home": [    "string"  ],  "homeFrom": "set",  "people": [    {      "userId": "string",      "email": "string",      "name": "string",      "role": "admin",      "roleName": "string",      "outside": true,      "endsAt": "string",      "ended": true    }  ],  "invitations": [    {      "id": "string",      "email": "string",      "role": "admin",      "roleName": "string",      "outside": true,      "endsAt": "string",      "expiresAt": "string"    }  ],  "counts": {    "own": 1,    "outside": 1  },  "me": {    "outside": true,    "mayLeave": true  }}

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.