Get a workspace overview
Returns the workspace's dashboard-visible integration state, connected repository catalog, plan status and saved model default, including your role and your own linked integration identity.
Any current workspace member can read it. This is read-only: it doesn't reconcile repositories, refresh provider tokens or expose credentials. Unknown workspaces and workspaces you don't belong to both answer 404 not_found.
/v1/workspaces/{workspaceId}A personal access token, which starts with sntr_. Create one on the dashboard's CLI & API page (https://app.sinatra.dev/tokens). It acts as you in every workspace you belong to, with your role in each, and expires after at most 365 days. The CLI's browser sign-in sends an OAuth access token here instead.
In: header
Path Parameters
The workspace's id, from GET /v1/me.
Response Body
curl -X GET "https://api.sinatra.dev/v1/workspaces/string"{
"id": "string",
"name": "string",
"role": "string",
"repoEnvironmentsStage": "string",
"repoEnvironmentsEnabled": true,
"github": {
"status": "string",
"accountLogin": "string",
"accountType": "string",
"installationId": "string"
},
"linear": {
"status": "string",
"organizationName": "string",
"organizationUrlKey": "string",
"currentUserHasReadToken": true,
"needsReconnect": true,
"recentTeams": [
{
"key": "string",
"taskCount": 0
}
]
},
"slack": {
"available": true,
"status": "string",
"teamName": "string",
"allowExternalSharedChannels": true,
"identity": {
"slackUserId": "string",
"displayName": "string"
}
},
"telegram": {
"available": true,
"enabled": true,
"connected": true
},
"connectors": {
"available": true
},
"repos": [
{
"id": "string",
"name": "string",
"shortDescription": "string",
"primaryLanguage": "string",
"stack": "string",
"preprocessing": {
"overallStatus": "string",
"metadata": {
"status": "string",
"error": "string"
},
"label": {
"status": "string",
"error": "string"
}
}
}
],
"repoCatalog": "string",
"planStatus": {
"plan": "enterprise"
},
"defaultModel": {
"engine": "string",
"model": "string",
"effort": "string"
}
}{
"error": "string",
"reason": "string",
"requestId": "string",
"refusal": "string",
"billingUrl": "string",
"settingsUrl": "string",
"plan": "string",
"running": 0,
"queued": 0,
"taskId": "string",
"messageId": "string"
}{
"error": "string",
"reason": "string",
"requestId": "string",
"refusal": "string",
"billingUrl": "string",
"settingsUrl": "string",
"plan": "string",
"running": 0,
"queued": 0,
"taskId": "string",
"messageId": "string"
}{
"error": "string",
"reason": "string",
"requestId": "string",
"refusal": "string",
"billingUrl": "string",
"settingsUrl": "string",
"plan": "string",
"running": 0,
"queued": 0,
"taskId": "string",
"messageId": "string"
}{
"error": "string",
"reason": "string",
"requestId": "string",
"refusal": "string",
"billingUrl": "string",
"settingsUrl": "string",
"plan": "string",
"running": 0,
"queued": 0,
"taskId": "string",
"messageId": "string"
}