Hosted platformREST API reference

Workspaces

Organization workspaces: members, roles, invitations, teams (rosters, leads, tenant bindings), organization SSO (browser sessions only) and the SCIM provisioning token.

Hosted platformAPI version 2.1.0

patch	/api/v1/workspace	Patch Workspace
delete	/api/v1/workspace	Leave Workspace
get	/api/v1/workspace/audit	Workspace Audit
post	/api/v1/workspace/convert	Convert Workspace
post	/api/v1/workspace/delete	Delete Workspace
post	/api/v1/workspace/invites	Invite
delete	/api/v1/workspace/invites/{invite_id}	Revoke Invite
post	/api/v1/workspace/invites/{invite_id}/resend	Resend Invite
get	/api/v1/workspace/members	Members
patch	/api/v1/workspace/members/{user_id}	Set Role
delete	/api/v1/workspace/members/{user_id}	Remove Member
get	/api/v1/workspace/scim	Scim Status
post	/api/v1/workspace/scim/token	Scim Token
delete	/api/v1/workspace/scim/token	Scim Revoke
get	/api/v1/workspace/sso	Sso Get
put	/api/v1/workspace/sso	Sso Put
delete	/api/v1/workspace/sso	Sso Delete
get	/api/v1/workspace/teams	List Teams
post	/api/v1/workspace/teams	Create Team
get	/api/v1/workspace/teams/{slug}	Team Detail
patch	/api/v1/workspace/teams/{slug}	Patch Team
delete	/api/v1/workspace/teams/{slug}	Delete Team
post	/api/v1/workspace/teams/{slug}/members	Add Team Member
delete	/api/v1/workspace/teams/{slug}/members/{user_id}	Remove Team Member
post	/api/v1/workspace/transfer	Transfer Ownership
get	/api/v1/workspaces	Workspaces
post	/api/v1/workspaces	Create Workspace
post	/api/v1/workspaces/{account_id}/switch	Switch Workspace

patch/api/v1/workspace

Patch Workspace

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyWorkspacePatch

Field	Type	Default	Description
name	string \| null
slug	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X PATCH "$OSR_URL/api/v1/workspace" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "default", "slug": "eu-health" }'

Bodyjson

{
  "name": "default",
  "slug": "eu-health"
}

delete/api/v1/workspace

Leave Workspace

Leave the current organization (owners must hand over first).

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/workspace" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/workspace/audit

Workspace Audit

Account-lifecycle events of this workspace (sign-ins, invitations, roles, removals). Admins only.

Requires an API key

Parameters

Name	In	Type	Default
limit	query	integer	100
before	query	number \| null
action	query	string \| null
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/workspace/audit?limit=100" \
  -H "Authorization: Bearer $OSR_API_KEY"

Turn the personal workspace into an organization so teammates can be invited. The plan, the subscription, the API keys, the tenants and the usage history stay exactly where they are; the user receives a fresh free personal workspace. Browser sessions stay on the converted workspace.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyWorkspaceConvertIn

Field	Type	Default	Description
name(required)	string
slug	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspace/convert" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "default" }'

Bodyjson

{
  "name": "default"
}

post/api/v1/workspace/delete

Delete Workspace

Delete the current organization - an owner's own exit, not a support ticket. Its keys, tenants, policy, members, invitations, SSO connection, usage and outcomes go at once; a live subscription is cancelled immediately so nothing more is billed (the paid remainder is not refunded here). Owner only, from a browser session; type the organization's name (or slug) to confirm, plus the password when one is set. Personal workspaces go with their user (POST /api/v1/me/delete). Every member's session moves to their personal workspace.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyDeleteWorkspaceIn

Field	Type	Default	Description
confirm	string	""
password	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspace/delete" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "password": "string" }'

Bodyjson

{
  "password": "string"
}

post/api/v1/workspace/invites

Invite

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyInviteIn

Field	Type	Default	Description
email(required)	string
role	string	"member"

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspace/invites" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "ada@example.com" }'

Bodyjson

{
  "email": "ada@example.com"
}

delete/api/v1/workspace/invites/{invite_id}

Revoke Invite

Requires an API key

Parameters

Name	In	Type	Default	Description
invite_id(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/workspace/invites/<invite_id>" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/workspace/invites/{invite_id}/resend

Resend Invite

Send a pending invitation again with a fresh link and a full validity period; the previous link stops working. The new link is returned once, as on creation.

Requires an API key

Parameters

Name	In	Type	Default	Description
invite_id(required)	path	string
x-goog-api-key	header	string \| null

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspace/invites/<invite_id>/resend" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/workspace/members

Members

The roster: every member with their workspace role and teams; pending invitations for admins.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/workspace/members" \
  -H "Authorization: Bearer $OSR_API_KEY"

patch/api/v1/workspace/members/{user_id}

Set Role

Requires an API key

Parameters

Name	In	Type	Default	Description
user_id(required)	path	string
x-goog-api-key	header	string \| null

Request bodyRoleIn

Field	Type	Default	Description
role(required)	string

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X PATCH "$OSR_URL/api/v1/workspace/members/<user_id>" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "role": "user" }'

Bodyjson

{
  "role": "user"
}

delete/api/v1/workspace/members/{user_id}

Remove Member

Requires an API key

Parameters

Name	In	Type	Default	Description
user_id(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/workspace/members/<user_id>" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/workspace/scim

Scim Status

Whether provisioning is on, the live token's age and use, how many people it provisioned, the base URL.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/workspace/scim" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/workspace/scim/token

Scim Token

Mint the provisioning token (owner role; shown once; replaces an earlier one). Paste it, with the base URL, into the identity provider's SCIM connector.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspace/scim/token" \
  -H "Authorization: Bearer $OSR_API_KEY"

delete/api/v1/workspace/scim/token

Scim Revoke

Revoke the provisioning token; the identity provider's calls fail with 401 from now on.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/workspace/scim/token" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/workspace/sso

Sso Get

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/workspace/sso" \
  -H "Authorization: Bearer $OSR_API_KEY"

put/api/v1/workspace/sso

Sso Put

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodySsoConnectionIn

Field	Type	Default
client_id(required)	string
client_secret	string \| null
default_role	string	"member"
domains	string[]
issuer	string \| null
kind	string	"oidc"
label	string	"Company SSO"
role_map	object
scopes	string[]

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X PUT "$OSR_URL/api/v1/workspace/sso" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "client_id": "string" }'

Bodyjson

{
  "client_id": "string"
}

delete/api/v1/workspace/sso

Sso Delete

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/workspace/sso" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/workspace/teams

List Teams

Every team of the workspace with its size, its leads, the keys pinned to its tenant and, when bound to a tenant, that tenant's usage this month and today. mine names the caller's own teams.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/workspace/teams" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/workspace/teams

Create Team

Create a team (admin role). slug defaults to the name; tenant binds it to one of the workspace's tenants; members seeds the roster with workspace members (role member or lead).

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyTeamIn

Field	Type	Default
description	string	""
members	TeamMemberIn[]
name(required)	string
slug	string \| null
tenant	string \| null

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspace/teams" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "default" }'

Bodyjson

{
  "name": "default"
}

get/api/v1/workspace/teams/{slug}

Team Detail

The team with its roster (each person's profile, team role and workspace role) and its keys (prefixes).

Requires an API key

Parameters

Name	In	Type	Default	Description
slug(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/workspace/teams/<slug>" \
  -H "Authorization: Bearer $OSR_API_KEY"

patch/api/v1/workspace/teams/{slug}

Patch Team

Rename, describe or re-bind a team (admin role). tenant: "" unbinds it.

Requires an API key

Parameters

Name	In	Type	Default	Description
slug(required)	path	string
x-goog-api-key	header	string \| null

Request bodyTeamPatch

Field	Type	Default	Description
description	string \| null
name	string \| null
tenant	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X PATCH "$OSR_URL/api/v1/workspace/teams/<slug>" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "description": "string", "name": "default", "tenant": "string" }'

Bodyjson

{
  "description": "string",
  "name": "default",
  "tenant": "string"
}

delete/api/v1/workspace/teams/{slug}

Delete Team

Delete a team (admin role). Its members stay in the workspace; its keys keep working under the tenant but are no longer the team's.

Requires an API key

Parameters

Name	In	Type	Default	Description
slug(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/workspace/teams/<slug>" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/workspace/teams/{slug}/members

Add Team Member

Put a workspace member on the team (admin role, or a lead of the team). Only admins make leads.

Requires an API key

Parameters

Name	In	Type	Default	Description
slug(required)	path	string
x-goog-api-key	header	string \| null

Request bodyTeamMemberIn

Field	Type	Default	Description
role	string	"member"
user_id(required)	string

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspace/teams/<slug>/members" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "user_id": "string" }'

Bodyjson

{
  "user_id": "string"
}

delete/api/v1/workspace/teams/{slug}/members/{user_id}

Remove Team Member

Take a person off the team (admin role, or a lead of the team; a lead cannot remove another lead).

Requires an API key

Parameters

Name	In	Type
slug(required)	path	string
user_id(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/workspace/teams/<slug>/members/<user_id>" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/workspace/transfer

Transfer Ownership

Hand the organization to another member in one step: they become an owner, the caller keeps the role named by keep_role (default admin; leave removes the caller). Owner only, audited as workspace.transferred; both people are e-mailed.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyTransferIn

Field	Type	Default	Description
keep_role	string	"admin"
user_id(required)	string

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspace/transfer" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "user_id": "string" }'

Bodyjson

{
  "user_id": "string"
}

get/api/v1/workspaces

Workspaces

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/workspaces" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/workspaces

Create Workspace

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyWorkspaceIn

Field	Type	Default	Description
name(required)	string
slug	string \| null

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspaces" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "default" }'

Bodyjson

{
  "name": "default"
}

post/api/v1/workspaces/{account_id}/switch

Switch Workspace

Requires an API key

Parameters

Name	In	Type	Default	Description
account_id(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/workspaces/<account_id>/switch" \
  -H "Authorization: Bearer $OSR_API_KEY"

Something wrong or out of date on this page? Tell us - the page is named for you, so a one-line note is enough.

Content

Content publishing for the workspace's own website: the feeds it follows and the briefs it sends become posts written through the router as its own metered requests; posts are reviewed, published and delivered to its destinations (a signed webhook, WordPress, Ghost) with a retried delivery log, or pulled from `GET /content/posts` and the RSS at `GET /content/feed.xml`.

Scim

SCIM 2.0 (RFC 7643 / 7644) for the organization's identity provider - Entra ID, Okta, OneLogin and the like - authenticated with the provisioning token an owner minted under `/api/v1/workspace/scim`.

Workspaces

patch/api/v1/workspace

Parameters

Request bodyWorkspacePatch

Responses

delete/api/v1/workspace

Parameters

Responses

get/api/v1/workspace/audit

Parameters

Responses

post/api/v1/workspace/convert

Parameters

Request bodyWorkspaceConvertIn

Responses

post/api/v1/workspace/delete

Parameters

Request bodyDeleteWorkspaceIn

Responses

post/api/v1/workspace/invites

Parameters

Request bodyInviteIn

Responses

delete/api/v1/workspace/invites/{invite_id}

Parameters

Responses

post/api/v1/workspace/invites/{invite_id}/resend

Parameters

Responses

get/api/v1/workspace/members

Parameters

Responses

patch/api/v1/workspace/members/{user_id}

Parameters

Request bodyRoleIn

Responses

delete/api/v1/workspace/members/{user_id}

Parameters

Responses

get/api/v1/workspace/scim

Parameters

Responses

post/api/v1/workspace/scim/token

Parameters

Responses

delete/api/v1/workspace/scim/token

Parameters

Responses

get/api/v1/workspace/sso

Parameters

Responses

put/api/v1/workspace/sso

Parameters

Request bodySsoConnectionIn

Responses

delete/api/v1/workspace/sso

Parameters

Responses

get/api/v1/workspace/teams

Parameters

Responses

post/api/v1/workspace/teams

Parameters

Request bodyTeamIn

Responses

get/api/v1/workspace/teams/{slug}

Parameters

Responses

patch/api/v1/workspace/teams/{slug}

Parameters

Request bodyTeamPatch

Responses

delete/api/v1/workspace/teams/{slug}

Parameters

Responses

post/api/v1/workspace/teams/{slug}/members

Parameters

Request bodyTeamMemberIn

Responses

delete/api/v1/workspace/teams/{slug}/members/{user_id}