Get calendar event changes

GET

mailbox

calendar-events

changes

curl --request GET \
  --url https://app.qubrics.com/api/v1/mailbox/calendar-events/changes \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.qubrics.com/api/v1/mailbox/calendar-events/changes"

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/calendar-events/changes', 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/calendar-events/changes"

	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": {
    "created": [
      "<string>"
    ],
    "destroyed": [
      "<string>"
    ],
    "has_more": true,
    "mailbox_id": "<string>",
    "new_state": "<string>",
    "old_state": "<string>",
    "resource": "event",
    "sync_required": true,
    "updated": [
      "<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

Query Parameters

since_state

string

Event state from the previous changes response. Omit to establish a full-refresh baseline.

Required string length: 1 - 4096

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

limit

integer

default:100

Maximum changed IDs across the response, up to 100.

Required range: 1 <= x <= 100

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

Changes or an explicit full refresh requirement.

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.created

string[]

required

Maximum array length: 100

Opaque identifier scoped to the selected mailbox.

Required string length: 1 - 4096

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

data.destroyed

string[]

required

Maximum array length: 100

Opaque identifier scoped to the selected mailbox.

Required string length: 1 - 4096

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

data.has_more

boolean

required

data.mailbox_id

string

required

data.new_state

string

required

Opaque identifier scoped to the selected mailbox.

Required string length: 1 - 4096

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

data.old_state

string

required

Opaque identifier scoped to the selected mailbox.

Required string length: 1 - 4096

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

data.resource

enum<string>

required

Available options:

event

data.sync_required

boolean

required

data.updated

string[]

required

Maximum array length: 100

Opaque identifier scoped to the selected mailbox.

Required string length: 1 - 4096

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

Get calendar event changes

curl --request GET \
  --url https://app.qubrics.com/api/v1/mailbox/calendar-events/changes \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.qubrics.com/api/v1/mailbox/calendar-events/changes"

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/calendar-events/changes', 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/calendar-events/changes"

	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": {
    "created": [
      "<string>"
    ],
    "destroyed": [
      "<string>"
    ],
    "has_more": true,
    "mailbox_id": "<string>",
    "new_state": "<string>",
    "old_state": "<string>",
    "resource": "event",
    "sync_required": true,
    "updated": [
      "<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

Get calendar event changes

Authorizations

Scopes

Query Parameters

Response