hyreflow-ai Workspaces API
The Workspaces API from hyreflow-ai — 13 operation(s) for workspaces.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hyreflow-ai:hyreflow-ai-workspaces-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: hyreflow engine (local) Workspaces API
version: 0.1.0
tags:
- name: Workspaces
paths:
/api/v2/workspaces:
get:
summary: Workspaces List
description: 'Every workspace the caller''s user owns or belongs to (the M:N view). Same projected shape as
`/api/v2/me` (id/name/slug/role) — the slug is what `hyreflow workspace switch` takes. Carries the
caller''s `user` too so `workspace list` can name the signed-in account without a second call.'
operationId: workspaces_list_api_v2_workspaces_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
tags:
- Workspaces
post:
summary: Workspaces Create
description: 'Create an ADDITIONAL workspace owned by the caller (a user may own many). Enforces the 10-workspace
cap and validates the name. Starts at 0 credits — unless the caller never had the once-per-identity
welcome credits (an invitee, who gets no personal workspace at sign-in), in which case they land here.'
operationId: workspaces_create_api_v2_workspaces_post
requestBody:
content:
application/json:
schema:
additionalProperties: true
type: object
title: Body
default: {}
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
tags:
- Workspaces
/api/v2/workspaces/{workspace_id}:
delete:
summary: Workspace Delete
description: 'Owner-only delete (ENG-700): schedules the workspace for deletion in workspaces.DELETE_DAYS. It keeps
working until then; the ops loop then hard-deletes it (cascade, plus the owner''s account if it was
their last workspace). 409 while a paid plan will renew.'
operationId: workspace_delete_api_v2_workspaces__workspace_id__delete
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
patch:
summary: Workspace Rename
description: 'Rename a workspace and/or set its time zone ({name?, timezone?}). Any member may; non-members get 403 from
workspaces.rename_workspace / set_timezone. Returns {id, name, timezone}.'
operationId: workspace_rename_api_v2_workspaces__workspace_id__patch
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
title: Workspace Id
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
default: {}
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
/api/v2/workspaces/{workspace_id}/cancel-deletion:
post:
summary: Workspace Cancel Deletion
description: 'Owner-only: keep a workspace that was scheduled for deletion.'
operationId: workspace_cancel_deletion_api_v2_workspaces__workspace_id__cancel_deletion_post
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
/api/v2/workspaces/members/{target_user_id}:
delete:
summary: Workspace Remove Member
description: Owner removes another member from the active workspace. Owner-gated; the owner can't be removed.
operationId: workspace_remove_member_api_v2_workspaces_members__target_user_id__delete
security:
- HTTPBearer: []
parameters:
- name: target_user_id
in: path
required: true
schema:
type: string
title: Target User Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
/api/v2/workspaces/members/spend-caps:
get:
summary: Workspace Member Spend Caps
description: 'Every member''s per-member USD cap + rolling-30d spend for the owner. Any other member gets only
their own row: a teammate''s spend is the owner''s view, same as `/billing/overview` (`_caller_scope`).'
operationId: workspace_member_spend_caps_api_v2_workspaces_members_spend_caps_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
tags:
- Workspaces
/api/v2/workspaces/members/{target_user_id}/spend-cap:
put:
summary: Workspace Set Member Spend Cap
description: 'Owner sets a member''s rolling-30d USD spend cap (ENG-590) — a member cannot change their own
cap. Refuses the same reason (`spending_cap_reached`, `cap_scope: "member"`)
as the workspace cap once the member''s own 30d spend + pending holds + a new charge would cross it.'
operationId: workspace_set_member_spend_cap_api_v2_workspaces_members__target_user_id__spend_cap_put
security:
- HTTPBearer: []
parameters:
- name: target_user_id
in: path
required: true
schema:
type: string
title: Target User Id
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
default: {}
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
delete:
summary: Workspace Clear Member Spend Cap
description: Owner clears a member's spend cap — the member goes back to uncapped.
operationId: workspace_clear_member_spend_cap_api_v2_workspaces_members__target_user_id__spend_cap_delete
security:
- HTTPBearer: []
parameters:
- name: target_user_id
in: path
required: true
schema:
type: string
title: Target User Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
/api/v2/workspaces/invites/{code}/revoke:
post:
summary: Workspace Revoke Invite
description: Revoke a pending workspace invite.
operationId: workspace_revoke_invite_api_v2_workspaces_invites__code__revoke_post
security:
- HTTPBearer: []
parameters:
- name: code
in: path
required: true
schema:
type: string
title: Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
/api/v2/workspaces/invites/{code}/accept:
post:
summary: Workspace Accept Invite
description: Accept a workspace invite for the signed-in user.
operationId: workspace_accept_invite_api_v2_workspaces_invites__code__accept_post
security:
- HTTPBearer: []
parameters:
- name: code
in: path
required: true
schema:
type: string
title: Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
/api/v2/workspaces/invites/{code}:
get:
summary: Workspace Invite Public
description: 'Unauthenticated invite preview for the accept-invite landing page — the invitee has the code
(emailed to them) but no session yet. Returns {workspace_name, email, status} only; 404 if unknown.'
operationId: workspace_invite_public_api_v2_workspaces_invites__code__get
parameters:
- name: code
in: path
required: true
schema:
type: string
title: Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
/api/v2/workspaces/domain-matches:
get:
summary: Workspace Domain Matches
description: 'Workspaces a colleague on the caller''s company email domain belongs to (ENG-699), paid first.
Empty for free-mail domains. Shown at onboarding so a new signup can ask to join instead.'
operationId: workspace_domain_matches_api_v2_workspaces_domain_matches_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
tags:
- Workspaces
/api/v2/workspaces/home:
post:
summary: Workspace Create Home
description: '"Create my own workspace" at the onboarding choice (ENG-699). Idempotent: a user who already has a
workspace gets that one back and nothing is created. A new one gets the once-per-identity welcome
credits. Binds the caller''s unbound session to it, and approves the waiting CLI claim (`cli_token`)
that sign-in left pending for this choice. A request still waiting on an owner is withdrawn (the owner
may be unreachable, and the confirmation screen must not be a dead end). Refused (409) once an owner
approved it: the invite is already in the user''s email.'
operationId: workspace_create_home_api_v2_workspaces_home_post
requestBody:
content:
application/json:
schema:
additionalProperties: true
type: object
title: Body
default: {}
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
tags:
- Workspaces
/api/v2/workspaces/{workspace_id}/access-requests:
post:
summary: Workspace Request Access
description: 'Email the owner of a domain-matched workspace that the caller wants in. Only workspaces in the
caller''s own domain_matches qualify (404 otherwise), one request per workspace per day.'
operationId: workspace_request_access_api_v2_workspaces__workspace_id__access_requests_post
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
/api/v2/workspaces/{workspace_id}/access-requests/approve:
post:
summary: Workspace Approve Access
description: 'Owner approves an access request by sending the requester a normal invite (same TTL, bound
email and accept page as workspace_create_invite).'
operationId: workspace_approve_access_api_v2_workspaces__workspace_id__access_requests_approve_post
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
title: Workspace Id
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
default: {}
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Workspaces
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer