Skip to content

See who is on call, the schedules and who is away

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

A token that can read is enough.

Done.

Media typeapplication/json
object
now
required
string
me
required
One of:
string
schedules
required
Array<object>
object
id
required
string
name
required
string
timeZone
required
string
layers
required
Array<object>
object
id
required
string
name
required
string
members
required
Array<string>
startsAt
required
string
handoff
required
One of:
object
every
required
string
Allowed values: week day
count
number
restrictions
Array<object>
object
days
required
Array<number>
start
required
string
end
required
string
endsAt
One of:
string
now
required
object
memberId
required
One of:
string
source
required
string
Allowed values: gap override layer
layerId
required
One of:
string
why
required
string
next24h
required
Array<object>
object
from
required
string
to
required
string
minutes
required
number
memberId
required
One of:
string
source
required
string
Allowed values: gap override layer
layerId
required
One of:
string
why
required
string
gapsNext14Days
required
Array<object>
object
from
required
string
to
required
string
minutes
required
number
memberId
required
One of:
string
source
required
string
Allowed values: gap override layer
layerId
required
One of:
string
why
required
string
policies
required
Array<object>
object
key
additional properties
covers
required
Array<object>
object
asked
required
Array<object>
object
memberId
required
string
why
required
string
state
required
string
offeredToMe
required
boolean
id
required
string
people
required
Array<object>
object
memberId
required
string
email
required
One of:
string
timeZone
required
string
country
required
One of:
string
region
required
One of:
string
skills
required
Array<string>
nightOk
required
boolean
githubLogin
required
One of:
string
teams
required
Array<string>
shadows
required
Array<object>
object
scheduleId
required
string
traineeId
required
string
until
required
One of:
string
codeowners
required
object
set
required
boolean
lines
required
Array<string>
fairness
required
One of:
object
month
required
object
from
required
string
to
required
string
zone
required
string
people
required
Array<object>
object
memberId
required
string
hoursSoFar
required
number
hoursMonth
required
number
pages
required
number
nightPages
required
number
evenHours
required
number
swaps
required
Array<object>
object
scheduleId
required
string
from
required
string
to
required
string
awayMemberId
required
string
awayWhy
required
string
coverMemberId
required
One of:
string
coverHoursMonth
required
number
cannot
required
Array<object>
object
memberId
required
string
why
required
string
choices
required
number
payback
required
One of:
object
from
required
string
to
required
string
empty
required
One of:
object
message
required
string
next
required
string

Example

{  "now": "string",  "me": "string",  "schedules": [    {      "id": "string",      "name": "string",      "timeZone": "string",      "layers": [        {          "id": "string",          "name": "string",          "members": [            "string"          ],          "startsAt": "string",          "handoff": {            "every": "week",            "count": 1          },          "restrictions": [            {              "days": [                1              ],              "start": "string",              "end": "string"            }          ],          "endsAt": "string"        }      ],      "now": {        "memberId": "string",        "source": "gap",        "layerId": "string",        "why": "string"      },      "next24h": [        {          "from": "string",          "to": "string",          "minutes": 1,          "memberId": "string",          "source": "gap",          "layerId": "string",          "why": "string"        }      ],      "gapsNext14Days": [        {          "from": "string",          "to": "string",          "minutes": 1,          "memberId": "string",          "source": "gap",          "layerId": "string",          "why": "string"        }      ]    }  ],  "policies": [    {}  ],  "covers": [    {      "asked": [        {          "memberId": "string",          "why": "string",          "state": "string"        }      ],      "offeredToMe": true,      "id": "string"    }  ],  "people": [    {      "memberId": "string",      "email": "string",      "timeZone": "string",      "country": "string",      "region": "string",      "skills": [        "string"      ],      "nightOk": true,      "githubLogin": "string",      "teams": [        "string"      ]    }  ],  "shadows": [    {      "scheduleId": "string",      "traineeId": "string",      "until": "string"    }  ],  "codeowners": {    "set": true,    "lines": [      "string"    ]  },  "fairness": {    "month": {      "from": "string",      "to": "string",      "zone": "string"    },    "people": [      {        "memberId": "string",        "hoursSoFar": 1,        "hoursMonth": 1,        "pages": 1,        "nightPages": 1      }    ],    "evenHours": 1,    "swaps": [      {        "scheduleId": "string",        "from": "string",        "to": "string",        "awayMemberId": "string",        "awayWhy": "string",        "coverMemberId": "string",        "coverHoursMonth": 1,        "cannot": [          {            "memberId": "string",            "why": "string"          }        ],        "choices": 1,        "payback": {          "from": "string",          "to": "string"        }      }    ]  },  "empty": {    "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.