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.
const url = 'https://api.xovris.ai/v1/oncall';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/oncall \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
object
object
object
object
object
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.