Skip to main content

List connections

GET 
/workspace/:ws_id/connections

Returns a list of connections by a filter

Request​

Path Parameters

    ws_id stringrequired

    workspace ID

Query Parameters

Responses​

ok

Schema
    limit integer
    offset integer
    results object[]
  • Array [
    • attributes object
    property name* object
    value
    connection_type_id string
    created_at integer
    created_by string
    created_with_o_auth boolean
    creation_location string
    creation_method string
    description string
    display_name string
    external_id string

    ExternalId mapping to external entity identifier associated with this connection (used on revoke/uninstall events e.g.)

    full_name string
    icon_uri string
    id string
    is_shared boolean
    name string

    Connection names are unique per tenant as they are used in playbook YAML

    secret_manager string
    secret_manager_name string
    shared_from string
    shared_with string[]
    slug_name string
    status string
    tags string[]
    tenant_id string
    type_name string
    updated_at integer
    updated_by string
    used_by object
    subflows object
    count integer
    names string[]
    workspace_id string
    workspace_name string
  • ]
    • total integer
Loading...