Skip to main content
GET
Error

Authorizations

x-cdata-authtoken
string
header
required

A Sync user auth token. Generate one via POST /v2/users/generate-token.

Path Parameters

workspace_id
string
required

Workspace identifier.

Query Parameters

$filter
string

OData-style filter expression applied to the collection, on endpoints that support filtering (e.g. name eq 'my_job'). Filters on resource fields such as id and name. Substring matching with contains(name,'my_job') is case-insensitive. startswith and endswith retain their existing behavior; case sensitivity depends on the AppDB collation.

$orderby
string

OData-style sort expression applied to the collection, on endpoints that support sorting (e.g. name asc, created_at desc).

$top
integer

Maximum number of records to return (pagination), where supported.

$skip
integer

Number of records to skip before returning results (pagination), where supported.

Response

One or more connections

id
string
workspace_id
string
name
string
connector
string
connector_version
string
properties
object

Connector-specific connection properties. For connectors that expose non-connection-string credentials (for example Generic JDBC User and Password), those values are returned here as well, with sensitive values such as Password masked.

settings
object
labels
string[]
permissions
object
created_at
string<date-time>
updated_at
string<date-time>
connection_state
string
last_tested
string<date-time>
license_state
string