GET
/v1/workspacesList assigned workspaces
Current active company assignments; verified global authority may see all company workspaces.
Request, response and permissions →Reference · v1
REST API reference
12 operations for assigned companies, saved tasks, connections and verification jobs. All requests use resource-bound Bearer authorization.
Base URL
https://api.orchesphere.ai/v1GET
/v1/workspaces/{workspaceId}/connectionsList connection evidence
Provider read permission in the selected workspace/environment. Configured is not proof of live access; managed_admin entries are read-only external projections.
Request, response and permissions →GET
/v1/workspaces/{workspaceId}/portalsList assigned portals
Current company membership and a parent portal assignment, or company-owner authority.
Request, response and permissions →GET
/v1/workspaces/{workspaceId}/tasksList accessible tasks
Current company/portal access and a task assignment/role. This lists saved requested work, not provider execution.
Request, response and permissions →GET
/v1/workspaces/{workspaceId}/jobsList saved verification jobs
Provider read permission plus requester identity or jobs_read_all. Latest 100 matching saved jobs, newest first.
Request, response and permissions →GET
/v1/workspaces/{workspaceId}/jobs/{jobId}Get a saved job
Provider read permission plus requester identity or jobs_read_all. Missing and inaccessible jobs both return 404.
Request, response and permissions →POST
/v1/workspaces/{workspaceId}/tasksCreate a task
Portal admin/operator. Explicit assigneeEmail additionally requires the designated access administrator and an eligible active portal member. Saves requested work; no external execution.
Request, response and permissions →PATCH
/v1/workspaces/{workspaceId}/tasks/{taskId}Update a task
Task admin/contributor/reviewer. Reviewer can update status only. Reassignment is not exposed. Parent portal and company rights still apply.
Request, response and permissions →POST
/v1/workspaces/{workspaceId}/connections/{connectionId}/verifyQueue an identity verification
Provider verify permission, implemented identity adapter and current entitlement/quota. Requires Idempotency-Key; replay with the same workspace/requester/key and connection returns the existing job, possibly already terminal. A different connection conflicts.
Request, response and permissions →POST
/v1/workspaces/{workspaceId}/jobs/{jobId}/cancelCancel a saved job
Company owner, or non-viewer requester with provider read, or provider jobs_cancel_all. Applies to queued/retry_wait/running/blocked states; terminal jobs remain unchanged.
Request, response and permissions →PUT
/v1/workspaces/{workspaceId}/connections/{provider}/{environment}Configure a connection
Provider configure permission; browser_session also requires company owner. Allowed mode depends on catalog provider. Production entitlements/limits apply. Uses a credential reference only; changing settings invalidates previous evidence.
Request, response and permissions →PUT
/v1/workspaces/{workspaceId}/service-permissions/{provider}/{environment}Set exact service permissions
Designated global access administrator only, for an existing active/invited company member. Exact production/sandbox grant overrides the * default; empty actions deny access. Does not assign company membership.
Request, response and permissions →Provider coverage
The directory contains 157 provider entries. Identity verification adapters are listed below; the directory count is not an operational adapter count.
| Adapter | Provider identifier |
|---|---|
| QuickBooks Online | quickbooks |
| NetSuite | netsuite |
| Stripe | stripe |
| Pipe17 | pipe17 |
| BigCommerce | bigcommerce |
| Microsoft Entra | entra |
| Slack | slack |
| Asana | asana |
| HubSpot | hubspot |
| Cloudflare | cloudflare |
| GitHub | github |