Get a calendar

GET

mailbox

calendars

{calendar_id}

Get a calendar

curl --request GET \
  --url https://app.qubrics.com/api/v1/mailbox/calendars/{calendar_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.qubrics.com/api/v1/mailbox/calendars/{calendar_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.qubrics.com/api/v1/mailbox/calendars/{calendar_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.qubrics.com/api/v1/mailbox/calendars/{calendar_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": true,
  "data": {
    "etag": "<string>",
    "id": "<string>",
    "is_default": true,
    "mailbox_id": "<string>",
    "name": "<string>",
    "time_zone": "<string>"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

Authorizations

Authorization

string

header

required

Qubrics API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Scopes

calendar.read

Read calendars and events in this mailbox

Headers

If-None-Match

string

ETag from a previous resource GET; a matching version returns 304.

Path Parameters

calendar_id

string

required

Calendar ID in the selected mailbox.

Required string length: 1 - 4096

Pattern: ^[A-Za-z0-9_-]+$

Query Parameters

mailbox_id

string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Calendar.

meta

object

required

Hide child attributes

meta.request_id

string

required

Example:

"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"

enum<boolean>

required

Available options:

true

data

object

required

Hide child attributes

data.etag

string

required

Current calendar version, matching the ETag response header. Use this value in If-Match to delete an empty calendar.

data.id

string

required

Opaque identifier scoped to the selected mailbox.

Required string length: 1 - 4096

Pattern: ^[A-Za-z0-9_-]+$

data.is_default

boolean

required

Whether this is the mailbox's current default calendar.

data.mailbox_id

string

required

data.name

string

required

data.time_zone

string | null

required

Get a calendar

curl --request GET \
  --url https://app.qubrics.com/api/v1/mailbox/calendars/{calendar_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.qubrics.com/api/v1/mailbox/calendars/{calendar_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.qubrics.com/api/v1/mailbox/calendars/{calendar_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.qubrics.com/api/v1/mailbox/calendars/{calendar_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": true,
  "data": {
    "etag": "<string>",
    "id": "<string>",
    "is_default": true,
    "mailbox_id": "<string>",
    "name": "<string>",
    "time_zone": "<string>"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "<string>",
    "retryable": false,
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_string",
        "field": "recipient.email",
        "message": "<string>"
      }
    ],
    "param": "<string>"
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": false
}

Overview

Mailboxes

Session and identity

Messages

Saved drafts

Attachments

Threads

Folders

Calendars

Submissions

Usage

Sync

Authorizations

Scopes

Headers

Path Parameters

Query Parameters

Response