Skip to content
Vibase Vibase Docs

Get a connection

GET
/meta/v1/connections/{id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
id
required
string format: uuid
organization_id
required
string format: uuid
provider
required

The provider of the account; google only for now.

string
Allowed values: google
account_id
required

The provider’s stable id for the account (Google’s sub). Not the address: an address can change.

string
identity_id
required

The own identity that is the connected mailbox’s address.

string format: uuid
owner_id
required

The user who owns the connection now; the person whose approval sends from it. A reconnect by another person moves it.

string format: uuid
status
required

Active works; reauth_required when the provider refused the stored grant; suspended when the owner is no longer admitted. A reconnect makes it active again.

string
Allowed values: active reauth_required suspended
granted_scopes
required

The OAuth scopes the person granted at the provider.

Array<string>
connected_at
required

When the connection was made or last reconnected.

string
created_by
required
string format: uuid
created_at
required
string
updated_at
required
string
last_synced_at

When the mailbox was last brought up to date; null until a sync has finished. Derived, read-only.

string | null
last_error_code

A short code for the last sync failure; null when the last run was fine or none ran. Derived, read-only.

string | null