User API

Calendars

Calendar sync and events

GET/calendars

List calendars

Query parameters

userIdstring

Responses

200Calendars

ok reqenumtrue

calendars reqany[]

pageinteger

perPageinteger

totalinteger

Request

curl 'https://app.openassistant.us/api/calendars' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "calendars": [
    {
      "id": "string",
      "platform": "google",
      "name": "string",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z",
      "role": "string",
      "isPrimary": true,
      "userIdentifier": "string",
      "ownerEmail": "string"
    }
  ]
}

GET/calendars/{calendarId}

Get a calendar

Path parameters

calendarId reqstring

Responses

200Calendar

ok reqenumtrue

calendar reqobject

id reqstring

platform reqenumgoogleazureapple

name reqstring

timezonestring

etagstring | null

referenceIdstring

conferenceSolutionsany[]

backgroundColorstring | null

lastSyncedAtstring | null

lastSyncTokenstring | null

syncErrorstring | null

syncErrorCountnumber

syncErrorAtstring | null

connectedAtstring | null

eventCountnumber

createdAt reqstring

updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/calendars/<calendarId>' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "calendar": {
    "id": "string",
    "platform": "google",
    "name": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}

GET/calendars/{calendarId}/events

Get calendar events

Path parameters

calendarId reqstring

Query parameters

timezonestring

startsAtstring

endsAtstring

Responses

200Events

ok reqenumtrue

events reqany[]

Request

curl 'https://app.openassistant.us/api/calendars/<calendarId>/events' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "events": [
    null
  ]
}

POST/calendars/{calendarId}/sync-events

Sync calendar events

Path parameters

calendarId reqstring

Responses

200Synced

ok reqenumtrue

syncEvents reqobject

message reqstring

Request

curl 'https://app.openassistant.us/api/calendars/<calendarId>/sync-events' \
  -X POST \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "syncEvents": {
    "message": "string"
  }
}