List Workspace Connections

GET

/api/app/{app_slug}/workflow/connections/

curl --request GET \
  --url https://api.agentaab.com/api/app/example/workflow/connections/ \
  --header 'Authorization: Bearer <token>'

List active and attention-required Workspace Connections in the Workflow’s creator or organization scope. Returned summaries are redacted.

Authorizations

• creatorBearerAuth
• creatorSessionCookieAuth

Parameters

Path Parameters

app_slug

required

string

Responses

200

Redacted live Connection summaries. Deleted Connections are omitted.

Media typeapplication/json

object

connections

required

Array<object>

Redacted Workspace Connection state. It contains a server-managed reference and sanitized capabilities, never private credential material.

object

id

required

string

credential_ref

required

Opaque server-managed reference used by materialized v1 Tool bindings.

string

/^WORKSPACE_CONNECTION_[A-F0-9]{32}$/

scope

required

object

kind

required

string

Allowed values: creator organization

id

required

string

provider

required

string

Allowed values: web_search mcp

display_name

required

string

endpoint

required

string format: uri

nullable

configuration

required

Bounded provider configuration with credential-shaped fields forbidden.

object

key

additional properties

any

credential_mode

required

string

Allowed values: bearer x_api_key

cached_capabilities

required

Sanitized bounded capability marker or MCP Tool manifest from the last successful test.

object

key

additional properties

any

status

required

string

Allowed values: active error deleted

last_tested_at

required

string format: date-time

nullable

last_error_code

required

string

nullable

Allowed values: workspace_connection_test_required workspace_connection_auth_unavailable workspace_connection_provider_unavailable

created_at

required

string format: date-time

updated_at

required

string format: date-time

rotated_at

required

string format: date-time

nullable

deleted_at

required

string format: date-time

nullable

Example

{
  "connections": [
    {
      "scope": {
        "kind": "creator"
      },
      "provider": "web_search",
      "credential_mode": "bearer",
      "status": "active",
      "last_error_code": "workspace_connection_test_required"
    }
  ]
}

401

The creator session is missing, invalid, expired, or does not have a verified email.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: creator_session_required creator_email_unverified creator_session_invalid creator_session_expired

Example

{
  "code": "creator_session_required"
}

403

A public Agent Business runtime credential cannot access creator control-plane APIs.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: runtime_token_not_allowed

Example

{
  "code": "runtime_token_not_allowed"
}

404

The Workflow or Connection scope is unavailable to this creator.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: application_unavailable

Example

{
  "code": "application_unavailable"
}

409

The Agent Business is not a Workflow, or the creator identity conflicts with an existing binding.

Media typeapplication/json

One of:

object

object

error

required

string

code

required

string

Allowed values: application_not_workflow

object

object

error

required

string

code

required

string

Allowed values: creator_identity_conflict

Example

{
  "code": "application_not_workflow"
}

500

An unexpected Workspace Connection failure was sanitized before returning it.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: workspace_connection_failed

Example

{
  "code": "workspace_connection_failed"
}

502

The configured creator identity service failed while verifying the session.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: creator_session_verification_failed

Example

{
  "code": "creator_session_verification_failed"
}

503

Creator auth, control-plane storage, or authoritative Connection storage is unavailable.

Media typeapplication/json

One of:

object

object

error

required

string

code

required

string

Allowed values: creator_auth_provider_invalid creator_session_not_configured creator_control_storage_not_configured

object

object

error

required

string

code

required

string

Allowed values: workspace_connection_encryption_unavailable workspace_connection_decryption_failed workspace_connection_store_unavailable workspace_connection_mutations_disabled workspace_connection_test_state_unavailable

Example

{
  "code": "creator_auth_provider_invalid"
}