Admiral Business API

The business API from Admiral — 7 operation(s) for business.

GitHub OpenAPI

Operations 8

GET /business Workspaces #
GET /business/{org_id} Read Profile #
PATCH /business/{org_id} Save Profile #
POST /business/{org_id}/reset Reset Profile #
POST /business/{org_id}/website Read Website #
POST /business/{org_id}/website/continue Continue Website #
POST /business/{org_id}/prepare Prepare Brief #
POST /business/{org_id}/sources/linkedin Import Linkedin #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/meetadmiral-com:meetadmiral-com-business-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. 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 Specification

meetadmiral-com-business-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Admiral Business API
  version: 0.1.0
tags:
- name: Business
paths:
  /business:
    get:
      tags:
      - Business
      summary: Workspaces
      operationId: workspaces_business_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /business/{org_id}:
    get:
      tags:
      - Business
      summary: Read Profile
      operationId: read_profile_business__org_id__get
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Business
      summary: Save Profile
      operationId: save_profile_business__org_id__patch
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileWrite'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /business/{org_id}/reset:
    post:
      tags:
      - Business
      summary: Reset Profile
      description: 'Start over: everything Admiral read and every answer the customer gave,

        cleared, and the first run back at its Start screen.


        A draft still parked for an account is discarded with it: it was written

        from the facts being cleared, Overview would keep leading with it, and

        the next draft would be refused while it existed. A draft already bound

        to an ad account, and anything running there, is not touched — those

        carry their own copy of the facts. Nothing here is charged.'
      operationId: reset_profile_business__org_id__reset_post
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /business/{org_id}/website:
    post:
      tags:
      - Business
      summary: Read Website
      operationId: read_website_business__org_id__website_post
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanWrite'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /business/{org_id}/website/continue:
    post:
      tags:
      - Business
      summary: Continue Website
      operationId: continue_website_business__org_id__website_continue_post
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanWrite'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /business/{org_id}/prepare:
    post:
      tags:
      - Business
      summary: Prepare Brief
      description: 'Reuse the catalogued reader on saved evidence, once per website scan.


        The durable credit request protects retries across process restarts. A

        completed model result can be reapplied without another provider call;

        customer edits made while it ran always take priority.'
      operationId: prepare_brief_business__org_id__prepare_post
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanWrite'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /business/{org_id}/sources/linkedin:
    post:
      tags:
      - Business
      summary: Import Linkedin
      operationId: import_linkedin_business__org_id__sources_linkedin_post
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Org Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyImport'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ProfileWrite:
      properties:
        version:
          type: integer
          minimum: 0.0
          title: Version
        fields:
          $ref: '#/components/schemas/BusinessFields'
        step:
          type: string
          enum:
          - about
          - audience
          - review
          title: Step
          default: about
        confirm:
          type: boolean
          title: Confirm
          default: false
      additionalProperties: false
      type: object
      required:
      - version
      title: ProfileWrite
    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
    CompanyImport:
      properties:
        version:
          type: integer
          minimum: 0.0
          title: Version
        company:
          $ref: '#/components/schemas/CompanyRead'
      additionalProperties: false
      type: object
      required:
      - version
      - company
      title: CompanyImport
    CompanyRead:
      properties:
        url:
          type: string
          maxLength: 500
          title: Url
        name:
          type: string
          maxLength: 120
          minLength: 1
          title: Name
        description:
          type: string
          maxLength: 5000
          title: Description
          default: ''
        website:
          type: string
          maxLength: 500
          title: Website
          default: ''
        industry:
          type: string
          maxLength: 200
          title: Industry
          default: ''
        specialties:
          items:
            type: string
          type: array
          maxItems: 30
          title: Specialties
        headquarters:
          type: string
          maxLength: 300
          title: Headquarters
          default: ''
        size:
          type: string
          maxLength: 80
          title: Size
          default: ''
      additionalProperties: false
      type: object
      required:
      - url
      - name
      title: CompanyRead
    ResetBody:
      properties:
        version:
          type: integer
          title: Version
      additionalProperties: false
      type: object
      required:
      - version
      title: ResetBody
    ScanWrite:
      properties:
        version:
          type: integer
          minimum: 0.0
          title: Version
        fill_missing:
          type: boolean
          title: Fill Missing
          default: false
        whole_site:
          type: boolean
          title: Whole Site
          default: false
        scope:
          type: string
          enum:
          - business
          - all
          title: Scope
          default: business
        finish:
          type: boolean
          title: Finish
          default: false
      additionalProperties: false
      type: object
      required:
      - version
      title: ScanWrite
    BusinessFields:
      properties:
        name:
          type: string
          maxLength: 120
          title: Name
          default: ''
        description:
          type: string
          maxLength: 5000
          title: Description
          default: ''
        website:
          type: string
          maxLength: 500
          title: Website
          default: ''
        business_type:
          type: string
          enum:
          - ''
          - individual
          - smb
          - enterprise
          title: Business Type
          default: ''
        selling_model:
          type: string
          enum:
          - ''
          - d2c
          - b2b
          - b2c
          - mixed
          title: Selling Model
          default: ''
        offerings:
          type: string
          maxLength: 2000
          title: Offerings
          default: ''
        audience:
          type: string
          maxLength: 2000
          title: Audience
          default: ''
        countries:
          items:
            type: string
            pattern: ^[A-Z]{2}$
          type: array
          maxItems: 250
          title: Countries
        goal:
          type: string
          maxLength: 1000
          title: Goal
          default: ''
      additionalProperties: false
      type: object
      title: BusinessFields