Get the caller's calendar assistant status (user)

Whether the calendar assistant is switched on for the caller, which provider it would use, and the resolved timezone with its source. Unlike every other endpoint on this page, this one never 403s for "not enabled": it is the one call a client can make to find that out.

timezone_source is one of:

mailbox_settings: read from the provider's own admin-confirmed settings (Microsoft MailboxSettings.Read only; Google has no equivalent and never produces this value).
user_setting: the caller's own assistant_timezone preference.
pbx_default: config('app.timezone'), the lowest rung of the chain. Never a silent UTC assumption.

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme: bearer
Bearer format: Bearer <token>

accept header · string

example: application/json

Responses

Response schema

dataobject

enabledboolean

providerstring | null

enum: microsoft google null

timezonestring

timezone_sourcestring

enum: mailbox_settings user_setting pbx_default

Unauthenticated. The `Authorization: Bearer <token>` header was missing, malformed, or names a token that has been revoked or deleted.

Response schema

messagestring

get https://cockpit.voxbi.com/api/v1/me/calendar/status

Base URL

Request sample

curl -X GET 'https://cockpit.voxbi.com/api/v1/me/calendar/status' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://cockpit.voxbi.com/api/v1/me/calendar/status', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.get('https://cockpit.voxbi.com/api/v1/me/calendar/status',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)

<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/me/calendar/status', false, $context);
$data = json_decode($response, true);
print_r($data);

{ … }

"data": { … }

"enabled": true,

"provider": "google",

"timezone": "Europe/Luxembourg",

"timezone_source": "user_setting"

}

{ … }

"message": "Unauthenticated."

}

Content-Type string

example: application/json

No matching endpoints

Get the caller's calendar assistant status (user)

Responses