Skip to main content
GET
Get connection

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

connectionId
string
required

Opaque identifier of the connection.

Pattern: ^conn_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Response type for a workspace connection.

Note: The encrypted connection data is never exposed in API responses. Only metadata about the connection is returned.

Response type for a workspace connection.

Note: The encrypted connection data is never exposed in API responses. Only metadata about the connection is returned.

connectionType
required

Capability category of the connection (object store, file service).

Allowed value: "object_store"
createdAt
string<date-time>
required

When the connection was created.

createdBy
object
required

Account that created this connection.

displayName
string
required

Human-readable connection display name.

id
string
required

Opaque identifier of the connection.

Pattern: ^conn_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
isActive
boolean
required

Whether the connection is enabled.

provider
string
required

Provider identifier (s3, azure, gcs, google_drive, dropbox, ...).

updatedAt
string<date-time>
required

When the connection was last updated.

workspaceHandle
string
required

URL-safe workspace handle. Display-only.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
workspaceId
string<uuid>
required

Unique identifier of the workspace.

lastSyncedAt
string<date-time>

When the connection last synced successfully, if ever. Independent of sync: a connection with no schedule still records its on-demand syncs.

sync
object

Scheduled-sync configuration; present only for connections that sync on a timer. Its absence does not mean the connection cannot sync — a file service and an unscheduled object store both transfer on demand.