IntegrationSafeRead

A company-level external integration — currently calendar providers (Google or YClients). Integrations are normally created through the provider's OAuth connect flow. IntegrationSafeRead omits the secret/token config.

idIdrequired

Unique numeric identifier of the record.

company_idCompany Idrequired

ID of the owning company (the top-level tenant account).

vendorVendorrequired

The integration provider — google or yclients.

Possible values: [google, yclients]

name objectrequired

Optional human-readable name.

anyOf

• string
• null

string

username objectrequired

Optional account username/identifier at the provider.

anyOf

• string
• null

string

typeTyperequired

Integration kind (currently "calendar").

Constant value: calendar

is_activeIs Activerequired

Whether the integration is active.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

IntegrationSafeRead

{
  "id": 0,
  "company_id": 0,
  "vendor": "google",
  "name": "string",
  "username": "string",
  "type": "calendar",
  "is_active": true,
  "created_at": "2024-07-29T15:51:28.071Z"
}