Skip to content

Workspace sync

Get workspace fork lineage

Read this workspace and its direct parent, or `parent: null` when it has no active parent. Requires workspace Admin access. The relationship does not grant access to the parent. Billing-enabled deployments require Enterprise. Billing-disabled deployments require forking to be enabled by deployment feature configuration, such as `FORKING_ENABLED`. Workspace API keys return `403`; use a personal API key or scoped OAuth token. OAuth scope: `api:read`.

GET/api/v2/workspaces/{workspaceId}/fork/lineage

Read this workspace and its direct parent, or parent: null when it has no active parent. Requires workspace Admin access. The relationship does not grant access to the parent. Billing-enabled deployments require Enterprise. Billing-disabled deployments require forking to be enabled by deployment feature configuration, such as FORKING_ENABLED. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:read.

Authentication

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

Send X-API-Key in the request header.

Alternatively

Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.

Authorization: Bearer YOUR_ACCESS_TOKEN

Required scopes: api:read

OAuth flows
json
{
  "authorizationCode": {
    "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
    "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "scopes": {
      "api:read": "Read your workspaces, workflows, files, tables, and logs",
      "api:write": "Read, create, change, run, and delete resources in your workspaces",
      "offline_access": "Stay signed in without asking again"
    }
  }
}

OAuth scope: api:read.

Path parameters

workspaceIdstringRequired

Explicit current workspace scope.

minLength
1
maxLength
128

Responses

200

Current workspace and its active direct parent, when present.

object

Current workspace and its active direct parent, when present.

1 field
dataobjectRequired

Response data.

2 fields
currentobjectRequired

The current workspace lineage node.

3 fields
idstringRequired

Resource identifier.

minLength
1
maxLength
128
namestringRequired

Display name of the workflow or workspace.

maxLength
1024
organizationIdvalueRequired

Owning organization, or null for a personal workspace.

Schema details

Any of

Option 1string
Option 2null

Additional properties are not allowed.

parentvalueRequired

The live parent workspace, or null when this workspace is not a fork.

Schema details

Any of

Option 1object
3 fields
idstringRequired

Resource identifier.

minLength
1
maxLength
128
namestringRequired

Display name of the workflow or workspace.

maxLength
1024
organizationIdvalueRequired

Owning organization, or null for a personal workspace.

Schema details

Any of

Option 1string
Option 2null

Additional properties are not allowed.

Option 2null

Additional properties are not allowed.

Additional properties are not allowed.

Was this helpful?
Suggest an edit