OpenAPI reference · Workspace

One-call workspace overview

GET/workspaces/context

The /workspaces/me block plus the workspace review gate and up to 25 projects enriched with stored LinkedIn connection health and posting streaks. The LinkedIn block reports the STORED status as of lastValidatedAt — this endpoint never probes LinkedIn live. projectsTruncated: true means the workspace has more than 25 projects; page the rest via GET /projects. Requires the workspace:read scope.

Authorization

Authorizationstringrequired
Bearer token in the Authorization header.
Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Header parameters

Scripe-Api-Versionstring
Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Responses

200

Workspace context pack.

workspaceobjectrequired
idstringrequired
namestringrequired
planstringrequired
featuresobjectrequired
principalobject | objectrequired
The credential this request authenticated with. API keys and OAuth tokens carry different fields — an OAuth token names the host, the consenting human, and the project that writes fall back to when a call omits projectId.
typestringrequired
Allowed values: api_key
idstringrequired
scopesstring[]
typestringrequired
Allowed values: oauth_token
idstringrequired
Encoded access-token id the host is presenting.
clientIdstringrequired
Registered OAuth client (the MCP host).
actingUserIdstringrequired
Clerk user id of the consenting human.
scopesstring[]required
defaultProjectobject | nullrequired
Project pinned on the consent screen. Every write — and every project-scoped read — falls back to it when the call omits projectId, so this is the project an agent should name when it reports what it did. name is the display name (the same one /projects returns), not the stored column, which is empty for most personal brands. null when the user pinned nothing or the project is gone.
requireReviewWorkflowbooleanrequired

projectsobject[]required

idstringrequired
namestringrequired
Display name used in the Scripe dashboard. For personal brands and amplifier accounts, this is the connected LinkedIn user's full name. For company pages, this is the LinkedIn-localized company name. Falls back to the internal project slug when no display data is available yet (e.g. mid-onboarding).
typestringrequired
Allowed values: PERSONAL_BRAND, COMPANY_PAGE, AMPLIFIER
typeLabelstringrequired
Human wording for type, matching the dashboard sidebar.
Allowed values: LinkedIn Account, Company Page, Amplifier Account
statusstringrequired
usernamestring | nullrequired
LinkedIn vanity slug. For personal brands and amplifiers this is the author profile slug (e.g. lukematthws, resolving to https://linkedin.com/in/lukematthws). For company pages this is the company vanity name (resolving to https://linkedin.com/company/<vanity>). null until the account has finished its LinkedIn handshake.
avatarUrlstring | nullrequired
CDN-cached profile picture / company logo URL. Falls back to the LinkedIn-hosted source if our CDN copy is not yet ready. null until LinkedIn data is available.
isActivebooleanrequired
createdAtstring <date-time>required

linkedInobject | any | nullrequired

Whether Scripe can publish as this project right now. null only when the project has no LinkedIn context at all — a company page that was never linked to an admin account — which is itself the answer "nothing can publish for it".

statestringrequired

Exactly one is true of any project at any instant.

state	publishes?	meaning
`connected`	yes	a token is on file and nothing is wrong
`expiring_soon`	yes	the access token lapses within 14 days (or already has) and has not been renewed
`degraded`	yes	recent LinkedIn calls failed; 3 consecutive failures revoke the connection
`disconnected`	no	no usable token — never connected, or the token was cleared
`revoked`	no	the authorization was withdrawn

Allowed values: connected, expiring_soon, degraded, disconnected, revoked

canPublishbooleanrequired
Whether publishing as this project is possible right now. True for connected, expiring_soon and degraded.
connectionStatusstringrequired
The raw stored status (CONNECTED / DEGRADED / DISCONNECTED / REVOKED / UNKNOWN). Kept so an integrator can see the cache value; it disagrees with state whenever token presence disagrees with it.
lastValidatedAtstring <date-time> | nullrequired
When the connection was last confirmed working.
accessTokenExpiresAtstring <date-time> | nullrequired
When the current access token lapses.
detailstring | nullrequired
One sentence naming what is wrong and what to do about it. null when state is connected.
reconnectUrlstring | nullrequired
Where a human reconnects the account in the Scripe dashboard. Reconnecting cannot be done through this API. null when there is nothing to fix.

streakobject | any | nullrequired
currentStreakintegerrequired
longestStreakintegerrequired

projectsTruncatedbooleanrequired

401
Missing, malformed, expired, or revoked API key.
403
Plan not eligible, scope missing, or workspace mismatch.
429
Sliding-window rate limit exceeded.

Example request

bash

curl --request GET \
  --url 'https://api.scripe.io/v1/workspaces/context' \
  --header 'Authorization: Bearer <token>'

Example response (200)

json

{
  "workspace": {
    "id": "org_2abcDEF",
    "name": "string",
    "plan": "ADVANCED",
    "features": {}
  },
  "principal": {
    "type": "api_key",
    "id": "key_a1b2c3d4e5f6g7h8",
    "scopes": [
      "string"
    ]
  },
  "requireReviewWorkflow": true,
  "projects": [
    {
      "id": "proj_a1b2c3d4e5f6g7h8",
      "name": "string",
      "type": "PERSONAL_BRAND",
      "typeLabel": "LinkedIn Account",
      "status": "ACTIVE",
      "username": "lukematthws",
      "avatarUrl": "string",
      "isActive": true,
      "createdAt": "2026-08-10T09:00:00Z",
      "linkedIn": {
        "state": "revoked",
        "canPublish": true,
        "connectionStatus": "CONNECTED",
        "lastValidatedAt": "2026-08-10T09:00:00Z",
        "accessTokenExpiresAt": "2026-08-10T09:00:00Z",
        "detail": "string",
        "reconnectUrl": "string"
      },
      "streak": {
        "currentStreak": 0,
        "longestStreak": 0
      }
    }
  ],
  "projectsTruncated": true
}

Authorization

Header parameters

Responses

Show 5 fields