REST reference · v1
List connection evidence
GET
/v1/workspaces/{workspaceId}/connectionsProvider read permission in the selected workspace/environment. Configured is not proof of live access; managed_admin entries are read-only external projections.
Company permissions
Provider read permission in the selected workspace/environment. Configured is not proof of live access; managed_admin entries are read-only external projections.
Required OAuth scopes: orchesphere.read. How scopes and company rights work.
Path and header parameters
| Name | Location | Required | Allowed values / bounds |
|---|---|---|---|
workspaceId | path | Yes | stringminLength: 8 · maxLength: 80 · pattern: ^[A-Za-z0-9_-]{8,80}$ |
Request
This operation does not accept a request body.
http
GET /v1/workspaces/{workspaceId}/connections HTTP/1.1
Host: api.orchesphere.ai
Authorization: Bearer <access_token>
Accept: application/jsonUse actual IDs returned for your assigned workspace. The example values are fictional. REST v1 accepts no query parameters.
Response · 200
| Field | Type | Required | Description / bounds |
|---|---|---|---|
connections | array | Yes | maxItems: 200 |
page | object | Yes | — |
runtime | object | Yes | — |
Complete response schema
{
"type": "object",
"properties": {
"connections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,80}$",
"minLength": 8,
"maxLength": 80
},
"version": {
"type": "integer",
"minimum": 1
},
"provider": {
"type": "string"
},
"name": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"production",
"sandbox"
]
},
"expectedAccountId": {
"type": "string"
},
"expectedCompanyName": {
"type": "string"
},
"authMode": {
"type": "string",
"enum": [
"secrets_manager",
"agentcore",
"browser_session",
"managed_admin"
]
},
"hasCredential": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"configured",
"authentication_required",
"permission_missing",
"provider_error",
"server_unavailable",
"identity_mismatch",
"adapter_required",
"data_read_verified",
"disconnect_pending"
]
},
"actualAccountId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"actualCompanyName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastCheckedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"lastReadAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"lastRenewedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"credentialCheckedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"credentialErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"credentialError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"allowedActions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read",
"verify",
"configure",
"jobs_read_all",
"jobs_cancel_all"
]
}
},
"providerContext": {
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"environment": {
"type": "string"
},
"roleId": {
"type": "string"
},
"roleName": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
},
"managedExternally": {
"type": "boolean"
},
"managedBy": {
"type": "string"
},
"manageUrl": {
"type": "string",
"format": "uri"
},
"note": {
"type": "string"
}
},
"required": [
"id",
"provider",
"name",
"environment",
"expectedAccountId",
"expectedCompanyName",
"authMode",
"hasCredential",
"state"
],
"additionalProperties": false
},
"maxItems": 200
},
"page": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"enum": [
100,
200
]
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 200
},
"mayHaveMore": {
"type": "boolean"
}
},
"required": [
"limit",
"returned",
"mayHaveMore"
],
"additionalProperties": false
},
"runtime": {
"type": "object",
"properties": {
"workerState": {
"type": "string",
"enum": [
"online",
"not_verified"
]
},
"lastHeartbeat": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"persistence": {
"type": "string",
"const": "PostgreSQL"
},
"unattendedVerified": {
"const": false
}
},
"required": [
"workerState",
"lastHeartbeat",
"persistence",
"unattendedVerified"
],
"additionalProperties": false
}
},
"required": [
"connections",
"page",
"runtime"
],
"additionalProperties": false
}json
{
"connections": [
{
"id": "22222222-2222-4222-8222-222222222222",
"version": 1,
"provider": "quickbooks",
"name": "QuickBooks Online",
"environment": "production",
"expectedAccountId": "example-account",
"expectedCompanyName": "Example Company",
"authMode": "secrets_manager",
"hasCredential": false,
"state": "configured",
"actualAccountId": null,
"actualCompanyName": null,
"lastCheckedAt": null,
"lastReadAt": null,
"lastRenewedAt": null,
"credentialCheckedAt": null,
"credentialErrorCode": null,
"credentialError": null,
"errorCode": null,
"error": null
}
],
"page": {
"limit": 200,
"returned": 1,
"mayHaveMore": false
},
"runtime": {
"workerState": "not_verified",
"lastHeartbeat": null,
"persistence": "PostgreSQL",
"unattendedVerified": false
}
}Errors
| Status | Meaning |
|---|---|
400 | Invalid path/query/body/header or business validation. |
401 | Missing, expired, revoked, invalid or wrong-resource token. |
402 | Verified company payment is required. |
403 | Insufficient token scope or current company/service/portal/task authority. |
404 | Unknown endpoint or record not found/inaccessible. |
405 | Method is not supported for this path. |
409 | State, quota or idempotency conflict; re-read current state. |
413 | Request exceeds 24,000 bytes. |
415 | Use uncompressed application/json. |
429 | Company job/rate/paid-period allowance reached. |
503 | Temporarily unavailable; a lost mutation response does not prove nothing was saved. |