B3 Organizations API
The Organizations API from B3 — 3 operation(s) for organizations.
The Organizations API from B3 — 3 operation(s) for organizations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/b3-organizations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: B3 Organizations API
version: '1.0'
description: 'Operations tagged Organizations across 2 of this provider''s published API definitions: b3-b3os-workflow-openapi.json, b3-organizations-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.b3os.org/v1
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Organizations
paths:
/v1/organizations:
get:
description: List all organizations for the current user
parameters:
- description: Number of items (default 20, max 100)
in: query
name: limit
schema:
type: integer
- description: Offset for pagination (default 0)
in: query
name: offset
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListOrganizationsSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/caddie-memory:
delete:
description: Delete ALL memories Caddie holds about the calling user in this organization. The user's enable toggle is preserved.
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClearCaddieMemorySuccessResponse'
description: OK
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Organizations
get:
description: List a page of what Caddie remembers about the calling user in this organization (newest first), plus the user's memory enable toggle. Identity is taken from the authenticated session — a user can only see their own memories.
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
- description: Number of items (default 20, max 100)
in: query
name: limit
schema:
type: integer
- description: Offset for pagination (default 0)
in: query
name: offset
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListCaddieMemorySuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Organizations
/v1/organizations/{orgId}/caddie-memory/org-settings:
put:
description: Enable or disable Caddie's long-term memory for this organization (admin-only). Memory is disabled by default; while disabled, Caddie does not recall, learn, or store facts for any member of the org.
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/UpdateCaddieMemoryOrgSettingsParams'
summary: request
description: Toggle state
description: Toggle state
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCaddieMemoryOrgSettingsSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Organizations
/v1/organizations/{orgId}/caddie-memory/settings:
put:
description: Enable or disable Caddie's memory of the calling user in this organization. When disabled, Caddie stops recalling, learning, and storing facts about the user.
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/UpdateCaddieMemorySettingsParams'
summary: request
description: Toggle state
description: Toggle state
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCaddieMemorySettingsSuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Organizations
/v1/organizations/{orgId}/caddie-memory/{scope}/{key}:
delete:
description: Delete one memory Caddie holds about the calling user in this organization.
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
- description: Memory scope (profile or notes)
in: path
name: scope
required: true
schema:
type: string
- description: Memory key
in: path
name: key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.SuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Organizations
put:
description: Edit the text of one memory Caddie holds about the calling user in this organization. Update-only — unknown keys return 404.
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
- description: Memory scope (profile or notes)
in: path
name: scope
required: true
schema:
type: string
- description: Memory key
in: path
name: key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/UpdateCaddieMemoryParams'
summary: request
description: New memory text
description: New memory text
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.SuccessResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Service Unavailable
tags:
- Organizations
/v1/organizations/{orgId}/database/query:
post:
description: Execute SQL query against org's database
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/ExecuteQueryParams'
summary: request
description: SQL query and parameters
description: SQL query and parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/database/tables:
get:
description: List all tables in the org's database
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
tables:
items:
$ref: '#/components/schemas/TableInfo'
type: array
type: object
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/database/tables/{tableName}:
get:
description: Get table schema (columns) from the org's database
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
- description: Table name
in: path
name: tableName
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
columns:
items:
$ref: '#/components/schemas/ColumnInfo'
type: array
type: object
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
tags:
- Organizations
/v1/organizations/{orgId}/plan-options:
get:
description: Returns all possible plan transitions with pre-calculated pricing
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetPlanOptionsResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/stripe/billing-details:
get:
description: Return Stripe payment methods and invoices for an organization
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetStripeBillingDetailsResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/stripe/checkout-sessions:
post:
description: Create a Stripe Checkout Session
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/CreateCheckoutSessionParams'
summary: body
description: Checkout session parameters
description: Checkout session parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCheckoutSessionResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/stripe/payment-methods/{pmId}:
delete:
description: Detach a payment method from the organization's Stripe customer
responses:
'200':
content:
application/json:
schema:
additionalProperties:
type: string
type: object
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/stripe/setup-intents:
post:
description: Create a Stripe SetupIntent for collecting a new payment method
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSetupIntentResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/stripe/subscriptions/downgrade:
post:
description: Downgrade a Stripe subscription (or cancel to free)
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/DowngradeStripeSubscriptionParams'
summary: body
description: Downgrade parameters
description: Downgrade parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DowngradeStripeSubscriptionResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/stripe/subscriptions/preview-upgrade:
get:
description: Returns pro-rated amounts for all upgrade-eligible tier+interval combos
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewUpgradeResponse'
description: OK
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
summary: Preview pro-rated upgrade pricing
tags:
- Organizations
/v1/organizations/{orgId}/stripe/subscriptions/reactivate:
post:
description: Reactivate a subscription with pending cancellation
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReactivateSubscriptionResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/v1/organizations/{orgId}/stripe/subscriptions/upgrade:
post:
description: Upgrade a Stripe subscription
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/UpgradeStripeSubscriptionParams'
summary: body
description: Upgrade parameters
description: Upgrade parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UpgradeStripeSubscriptionResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
tags:
- Organizations
/organizations/{orgId}/webhook-secret:
get:
description: Get the organization's webhook secret for triggering workflows via integration webhooks
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/data'
properties:
code:
type: integer
data: {}
message:
type: string
requestId:
type: string
type: object
description: OK
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
tags:
- Organizations
/v1/organizations/{orgId}/auto-swap-settings:
get:
description: Get automatic token swap settings for an organization. Returns a disabled default if not yet configured.
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/data'
properties:
code:
type: integer
data: {}
message:
type: string
requestId:
type: string
type: object
description: OK
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Internal Server Error
tags:
- Organizations
put:
description: Update automatic token swap settings for an organization. Owners only.
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
- $ref: '#/components/schemas/UpdateAutoSwapSettingsParams'
summary: body
description: Auto-swap settings
description: Auto-swap settings
required: true
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/data'
properties:
code:
type: integer
data: {}
message:
type: string
requestId:
type: string
type: object
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Not Found
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Internal Server Error
tags:
- Organizations
/v1/organizations/{orgId}/public:
get:
description: 'Retrieve public metadata for an organization (no authentication required)
This endpoint is used for organization detail pages'
parameters:
- description: Organization ID
in: path
name: orgId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/data'
properties:
code:
type: integer
data: {}
message:
type: string
requestId:
type: string
type: object
description: Organization public metadata
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Organization not found
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
description: Internal server error
summary: Get public organization metadata
tags:
- Organizations
components:
schemas:
UpdateCaddieMemoryOrgSettingsSuccessResponse:
properties:
data:
$ref: '#/components/schemas/UpdateCaddieMemoryOrgSettingsResponse'
type: object
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.CommentReply:
properties:
createdAt:
type: string
createdBy:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNoteUser'
id:
type: string
text:
type: string
updatedAt:
type: string
type: object
ClearCaddieMemoryResponse:
properties:
cleared:
type: integer
type: object
PreviewUpgradeResponse:
properties:
previews:
additionalProperties:
$ref: '#/components/schemas/PreviewUpgradeTierResult'
type: object
type: object
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNoteSize:
properties:
height:
type: number
width:
type: number
type: object
ReactivateSubscriptionResponse:
properties:
subscriptionId:
type: string
tier:
type: string
type: object
ListCaddieMemoryResponse:
properties:
enabled:
type: boolean
hasMore:
type: boolean
items:
items:
$ref: '#/components/schemas/CaddieMemoryItem'
type: array
uniqueItems: false
limit:
type: integer
offset:
type: integer
orgEnabled:
type: boolean
type: object
UpgradeStripeSubscriptionResponse:
properties:
interval:
type: string
newTier:
type: string
oldTier:
type: string
subscriptionId:
type: string
type: object
UpdateCaddieMemoryParams:
properties:
text:
maxLength: 2000
minLength: 1
type: string
required:
- text
type: object
PaginatedData-github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity_Organization:
properties:
hasMore:
type: boolean
items:
items:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Organization'
type: array
uniqueItems: false
limit:
type: integer
offset:
type: integer
type: object
UpdateCaddieMemorySettingsResponse:
properties:
enabled:
type: boolean
type: object
CreateCheckoutSessionParams:
properties:
interval:
type: string
tier:
type: string
required:
- tier
type: object
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowInput:
properties:
description:
type: string
key:
type: string
required:
type: boolean
type:
description: '"string", "number", "boolean", "object", "array"'
type: string
type: object
UpdateCaddieMemoryOrgSettingsParams:
properties:
enabled:
type: boolean
required:
- enabled
type: object
PreviewUpgradeTierResult:
properties:
amountDueCents:
description: net charge today
type: integer
type: object
UpdateCaddieMemoryOrgSettingsResponse:
properties:
enabled:
type: boolean
type: object
UpdateCaddieMemorySettingsParams:
properties:
enabled:
type: boolean
required:
- enabled
type: object
ListCaddieMemorySuccessResponse:
properties:
data:
$ref: '#/components/schemas/ListCaddieMemoryResponse'
type: object
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowNode:
properties:
blockContext:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.BlockNodeContext'
branch:
description: '"then"/"else" (if parent), "resumed"/"timed_out" (wait parent)'
type: string
children:
items:
type: string
type: array
uniqueItems: false
connector:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ConnectorReference'
description:
description: AI-generated 1-sentence description
type: string
loopBody:
description: Loop body nodes (only for for-each nodes)
items:
type: string
type: array
uniqueItems: false
payload:
additionalProperties: {}
type: object
resultSchema:
additionalProperties: {}
description: 'ResultSchema describes the output structure of this node (populated dynamically for x402 endpoints).
This is used by the frontend to show available output variables in the variable picker.'
type: object
titleOverride:
description: AI-generated short title (2-6 words), only when more descriptive than default
type: string
type:
type: string
required:
- payload
- type
type: object
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Comment:
properties:
createdAt:
type: string
createdBy:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNoteUser'
id:
type: string
nodeId:
type: string
position:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.NodePosition'
replies:
items:
$ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.CommentReply'
type: array
uniqueItems: false
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/b3/refs/heads/main/openapi/b3-organizations-api-openapi.yml