API referenceAdmin deals
Find a workspace to draft a deal for
Matches workspace names and slugs; reports whether each already has an open deal. Platform admins only.
Authorization
apiKey AuthorizationBearer <token>
Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Query Parameters
q?string|null
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/admin/deals/workspaces"{ "data": [ { "workspaceId": "string", "name": "string", "slug": "string", "billedPlan": "string", "hasOpenDeal": true } ]}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Draft an enterprise deal
Creates a draft deal for a workspace with the enterprise plan's limits as the starting point. One open deal per workspace.
Read one enterprise deal
The deal with its workspace, live billable seats, monthly value and subscription status. Platform admins only; an unknown `dealId` is reported as not found.