Calendar

List calendar events

Events on the calendar from from to to (days, at most 366 apart; the next 30 days when neither is given), by day and time. Or every event changed since updated_after, oldest change first, for a sync. recording_id keeps to the events heard in one recording. Suggestions heard in a recording and not accepted yet show only with include_suggested=true.

Authorization

apiKey

AuthorizationBearer <token>

Authorization: Bearer taad_… (or taadtest_… for the sandbox). Never in a URL, never in a web page.

In: header

Query Parameters

limit?integer

Range1 <= value <= 100

Default20

cursor?string

Lengthlength <= 500

from?string

Match^\d{4}-\d{2}-\d{2}$

to?string

Match^\d{4}-\d{2}-\d{2}$

updated_after?string

Match^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}(:\d{2}(\.\d+)?)?(Z|[+-]\d{2}:?\d{2}))?$

recording_id?string

Match^rec_[0-9A-HJKMNP-TV-Z]{26}$

include_suggested?string

Value in

"true"
"false"

Response Body

`application/json`

curl -X GET "https://example.com/v1/calendar_events"

{  "object": "list",  "data": [    {      "id": "string",      "object": "calendar_event",      "workspace_id": "string",      "title": "string",      "day": "string",      "start": "string",      "end": "string",      "category": "meeting",      "notes": "string",      "recurrence": {        "freq": "daily",        "interval": 1,        "until": null,        "days": [          0        ]      },      "series_id": "string",      "alerts": [        -9007199254740991      ],      "recording_id": "string",      "said_at_ms": -9007199254740991,      "source": "user",      "suggested": true,      "read_only": true,      "created_at": "string",      "updated_at": "string"    }  ],  "has_more": true,  "next_cursor": "string"}

Add a calendar event

With a recurrence, a repeating event: its occurrences are made as the calendar is read, each an event of its own sharing a series_id. The answer is the first.

Authorization

apiKey

AuthorizationBearer <token>

Authorization: Bearer taad_… (or taadtest_… for the sandbox). Never in a URL, never in a web page.

In: header

Header Parameters

Idempotency-Key?string

Any unique string (a UUID). Sending the same request again with the same key answers the first answer, and a paid call is never charged twice. Kept 24 hours.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

Length1 <= length <= 200

day*string

Match^\d{4}-\d{2}-\d{2}$

start?|

Defaultnull

end?|

Defaultnull

category?string

Default"other"

Value in

"meeting"
"call"
"deadline"
"reminder"
"class"
"other"

notes?|

Defaultnull

recurrence?|

Defaultnull

alerts?array<>

Itemsitems <= 5

Default[]

Response Body

`application/json`

curl -X POST "https://example.com/v1/calendar_events" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "day": "string"  }'

{  "id": "string",  "object": "calendar_event",  "workspace_id": "string",  "title": "string",  "day": "string",  "start": "string",  "end": "string",  "category": "meeting",  "notes": "string",  "recurrence": {    "freq": "daily",    "interval": 1,    "until": null,    "days": [      0    ]  },  "series_id": "string",  "alerts": [    -9007199254740991  ],  "recording_id": "string",  "said_at_ms": -9007199254740991,  "source": "user",  "suggested": true,  "read_only": true,  "created_at": "string",  "updated_at": "string"}

Get a calendar event

Authorization

apiKey

AuthorizationBearer <token>

Authorization: Bearer taad_… (or taadtest_… for the sandbox). Never in a URL, never in a web page.

In: header

Path Parameters

id*string

Lengthlength <= 64

Response Body

`application/json`

curl -X GET "https://example.com/v1/calendar_events/string"

{  "id": "string",  "object": "calendar_event",  "workspace_id": "string",  "title": "string",  "day": "string",  "start": "string",  "end": "string",  "category": "meeting",  "notes": "string",  "recurrence": {    "freq": "daily",    "interval": 1,    "until": null,    "days": [      0    ]  },  "series_id": "string",  "alerts": [    -9007199254740991  ],  "recording_id": "string",  "said_at_ms": -9007199254740991,  "source": "user",  "suggested": true,  "read_only": true,  "created_at": "string",  "updated_at": "string"}

Update a calendar event

Only the fields sent change. For a repeating event, scope says how far: one (this occurrence; the default), following (this one and those after it) or series (all of them), as in the app. Events from a connected Google or Outlook calendar are changed there (422).

Authorization

apiKey

AuthorizationBearer <token>

Authorization: Bearer taad_… (or taadtest_… for the sandbox). Never in a URL, never in a web page.

In: header

Path Parameters

id*string

Lengthlength <= 64

Header Parameters

Idempotency-Key?string

Any unique string (a UUID). Sending the same request again with the same key answers the first answer, and a paid call is never charged twice. Kept 24 hours.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title?string

Length1 <= length <= 200

day?string

Match^\d{4}-\d{2}-\d{2}$

start?|null

end?|null

category?string

Value in

"meeting"
"call"
"deadline"
"reminder"
"class"
"other"

notes?|null

recurrence?|null

alerts?array<>

Itemsitems <= 5

scope?string

Default"one"

Value in

"one"
"following"
"series"

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/calendar_events/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "object": "calendar_event",  "workspace_id": "string",  "title": "string",  "day": "string",  "start": "string",  "end": "string",  "category": "meeting",  "notes": "string",  "recurrence": {    "freq": "daily",    "interval": 1,    "until": null,    "days": [      0    ]  },  "series_id": "string",  "alerts": [    -9007199254740991  ],  "recording_id": "string",  "said_at_ms": -9007199254740991,  "source": "user",  "suggested": true,  "read_only": true,  "created_at": "string",  "updated_at": "string"}

Delete a calendar event

For a repeating event, scope says how far: one (the default), following or series.

Authorization

apiKey

AuthorizationBearer <token>

Authorization: Bearer taad_… (or taadtest_… for the sandbox). Never in a URL, never in a web page.

In: header

Path Parameters

id*string

Lengthlength <= 64

Query Parameters

scope?string

Default"one"

Value in

"one"
"following"
"series"

Header Parameters

Idempotency-Key?string

Any unique string (a UUID). Sending the same request again with the same key answers the first answer, and a paid call is never charged twice. Kept 24 hours.

Lengthlength <= 255

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/calendar_events/string"

{  "id": "string",  "object": "calendar_event",  "deleted": true}

List calendar eventsCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

429application/json

Add a calendar eventCopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

429application/json

Get a calendar eventCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

429application/json

Update a calendar eventCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

429application/json

Delete a calendar eventCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

429application/json

List calendar events

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Add a calendar event

Authorization

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Get a calendar event

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update a calendar event

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Delete a calendar event

Authorization

Path Parameters

Query Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`