Admiral Org API
The org API from Admiral — 8 operation(s) for org.
The org API from Admiral — 8 operation(s) for org.
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/meetadmiral-com:meetadmiral-com-org-api"
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.
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. 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: Admiral Org API
version: 0.1.0
tags:
- name: Org
paths:
/org:
get:
tags:
- Org
summary: Get Org
operationId: get_org_org_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
patch:
tags:
- Org
summary: Rename Org
operationId: rename_org_org_patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RenameBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/org/health:
patch:
tags:
- Org
summary: Set Health Mode
description: 'Health mode and the paths to keep tags off (app/health_mode.py). Owners only, like the name: it
decides what Admiral stores about the workspace''s leads. The paths take effect on the next Tag Manager
install; one already published keeps what it was published with until it is installed again.'
operationId: set_health_mode_org_health_patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HealthBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/org/invites:
post:
tags:
- Org
summary: Create Invite
operationId: create_invite_org_invites_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InviteBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/org/invites/{invite_id}:
delete:
tags:
- Org
summary: Revoke Invite
operationId: revoke_invite_org_invites__invite_id__delete
parameters:
- name: invite_id
in: path
required: true
schema:
type: string
format: uuid
title: Invite Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/org/invites/accept:
post:
tags:
- Org
summary: Accept Invite
operationId: accept_invite_org_invites_accept_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/org/members/{user_id}:
delete:
tags:
- Org
summary: Remove Member
operationId: remove_member_org_members__user_id__delete
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
title: User Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/org/delete:
post:
tags:
- Org
summary: Delete Workspace And Data
description: 'Delete the workspace and every row it owns, the drafts kept under the
owner''s email before sign-in, and (when they belong to no other
workspace) their sign-in, so the same email can start fresh.
A paid plan is told to stop renewing before anything commits: if the
payment provider can''t be reached, nothing is deleted, because a
workspace deleted with its plan still renewing would keep charging a card
with nothing behind it. Admiral''s own home workspace refuses: it receives every lead
(docs/lessons/a-refusal-only-the-visitor-reads-is-silent.md).'
operationId: delete_workspace_and_data_org_delete_post
parameters:
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWorkspaceBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/org/notifications:
get:
tags:
- Org
summary: Get Notifications
operationId: get_notifications_org_notifications_get
parameters:
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Org
summary: Set Notification
operationId: set_notification_org_notifications_patch
parameters:
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Choice'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
RenameBody:
properties:
name:
type: string
maxLength: 120
minLength: 1
title: Name
type: object
required:
- name
title: RenameBody
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
AcceptBody:
properties:
token:
type: string
maxLength: 128
minLength: 10
title: Token
type: object
required:
- token
title: AcceptBody
InviteBody:
properties:
email:
anyOf:
- type: string
maxLength: 254
- type: 'null'
title: Email
role:
type: string
pattern: ^(owner|member)$
title: Role
default: member
type: object
title: InviteBody
DeleteWorkspaceBody:
properties:
confirm:
type: string
maxLength: 40
title: Confirm
reason:
anyOf:
- type: string
pattern: ^(too_expensive|no_time|no_results|missing|other_tool|other)$
- type: 'null'
title: Reason
type: object
required:
- confirm
title: DeleteWorkspaceBody
Choice:
properties:
kind:
type: string
enum:
- decisions
- funds_low
title: Kind
enabled:
type: boolean
title: Enabled
type: object
required:
- kind
- enabled
title: Choice
HealthBody:
properties:
health_mode:
type: boolean
title: Health Mode
excluded_paths:
items:
type: string
type: array
maxItems: 50
title: Excluded Paths
type: object
required:
- health_mode
title: HealthBody