Agent HandlerConnections

Retrieve Connection

Retrieves a single connection by ID.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

connection_idstringRequiredformat: "uuid"

Response

idstringRead-onlyformat: "uuid"
connectorobject
organization_idstringRead-onlyformat: "uuid"
auth_option_namestring or nullRead-only
auth_typestringRead-only
auth_scopestringRead-only

The connection’s scope: INDIVIDUAL, SHARED, or ORGANIZATION.

statusstringRead-only

Connection status: ACTIVE (a token refresh succeeded, or the default for a freshly linked connection) or ERROR (a token refresh failed; the connection needs re-linking).

retired_atdatetime or nullRead-only

When set, the connection is retired (out of service) and surfaced as an issue. Null for live connections.

ownerobject
excluded_registered_userslist of stringsRead-only

Registered-user IDs blocked from this SHARED or ORGANIZATION connection. Always empty for INDIVIDUAL connections.

created_atdatetimeRead-only
modified_atdatetimeRead-only