Admiral Business Profile API

The business-profile API from Admiral — 20 operation(s) for business-profile.

GitHub OpenAPI

Operations 20

GET /profile Read Profile #
GET /profile/kept-draft Kept Draft #
GET /profile/first-read First Read #
POST /profile/draft/{draft_id}/bind Bind Draft #
POST /profile/claim Claim Draft #
POST /profile/draft Draft Campaign #
POST /profile/segment Choose Segment #
POST /profile/sources Read Sources #
POST /profile/rescan Rescan #
PATCH /profile/items Correct Item #
POST /profile/confirm Confirm Map #
POST /profile/advance Advance #
PATCH /profile/assumptions Set Assumptions #
POST /profile/budget Choose Budget #
POST /profile/competitors Name Competitors #
POST /profile/research-country Research Country #
POST /profile/market-read Market Read Endpoint #
PATCH /profile/exchange-rate Exchange Rate #
POST /profile/landing-page Draft Landing #
POST /profile/landing-page/{page_id}/check Check Landing #

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-profile-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-profile-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Admiral Business Profile API
  version: 0.1.0
tags:
- name: Business Profile
paths:
  /profile:
    get:
      tags:
      - Business Profile
      summary: Read Profile
      operationId: read_profile_profile_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'
  /profile/kept-draft:
    get:
      tags:
      - Business Profile
      summary: Kept Draft
      description: 'The newest plan kept before sign-in for the signed-in email, not yet

        claimed. The confirmation link can open in a browser that holds nothing

        of the interview, and the workspace then had no draft id to claim with:

        it sent the customer back to read their site and write the plan again

        (mailmycard.com, 2026-09-26). Only an id, only for this email; the

        claim still checks the email itself.'
      operationId: kept_draft_profile_kept_draft_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /profile/first-read:
    get:
      tags:
      - Business Profile
      summary: First Read
      description: 'What Admiral read on the customer''s site before they signed up — the

        findings and the money line they unlocked — for the workspace their

        plan was claimed into (join 3, 2026-09-24). It used to stop at the

        door: the console showed the campaign drafted from the read and never

        the read itself.


        The claim already links it: the profile names the claimed draft, and

        the draft names its read, so nothing new is stored. It comes back whole,

        because the address that unlocked it is the one the claim checked. None

        for a workspace that began some other way, or a draft claimed elsewhere.'
      operationId: first_read_profile_first_read_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'
  /profile/draft/{draft_id}/bind:
    post:
      tags:
      - Business Profile
      summary: Bind Draft
      operationId: bind_draft_profile_draft__draft_id__bind_post
      parameters:
      - name: draft_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Draft Id
      - 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/BindDraftBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/claim:
    post:
      tags:
      - Business Profile
      summary: Claim Draft
      description: 'The draft written before login comes into the workspace.


        The link the visitor opened carried the draft id; the signed-in email

        must be the one the draft was kept for — the id is unguessable, but a

        forwarded link must not move somebody else''s draft into a stranger''s

        workspace. The read, the market and the draft are copied into the same

        rows the journey writes (business_profiles, a parked launch_drafts row),

        so /welcome continues from the draft with nothing special-cased, and

        nothing is charged: the handoff fixes the anonymous read as unbilled.

        Idempotent — opening the link twice finds the draft already here.'
      operationId: claim_draft_profile_claim_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/ClaimBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/draft:
    post:
      tags:
      - Business Profile
      summary: Draft Campaign
      description: 'Draft the first campaign from the profile, before any ad account.


        The draft is parked — account_id NULL — until the customer chooses an

        active account on its channel through the explicit bind route, where the

        six approvals pick it up at "Check". The journey is USD-only (Decision

        1), so the first daily budget is the chosen band''s low edge spread over

        a month, in dollars.


        The channel is the customer''s, chosen beside the budget. It used to be

        the string "google", always, for every business — and `bind_parked_drafts`

        matches a draft to an account of the same channel, so a Meta advertiser

        walked the whole first run, paid for it, connected their Meta account and

        watched the draft never arrive. Both drafters have the same contract, so

        the only thing that was missing was the asking.'
      operationId: draft_campaign_profile_draft_post
      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'
  /profile/segment:
    post:
      tags:
      - Business Profile
      summary: Choose Segment
      operationId: choose_segment_profile_segment_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/SegmentBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/sources:
    post:
      tags:
      - Business Profile
      summary: Read Sources
      operationId: read_sources_profile_sources_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/SourcesBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/rescan:
    post:
      tags:
      - Business Profile
      summary: Rescan
      operationId: rescan_profile_rescan_post
      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'
  /profile/items:
    patch:
      tags:
      - Business Profile
      summary: Correct Item
      operationId: correct_item_profile_items_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/CorrectionBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/confirm:
    post:
      tags:
      - Business Profile
      summary: Confirm Map
      description: 'The map is right: read the market. Progress moves to `researching`

        first so a refresh mid-way shows the reading screen, then to `summary`.


        With `search_terms`, those are what Google is asked about, and they stay

        the customer''s for every later check (a country, asking again).'
      operationId: confirm_map_profile_confirm_post
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/ConfirmBody'
              - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/advance:
    post:
      tags:
      - Business Profile
      summary: Advance
      description: 'One station forward, or back to any earlier one.


        Skipping between the later stations is still refused — each is a decision

        Admiral asks the customer to look at, and a client that jumps past them

        has looked at none.


        The map is the exception, and deliberately so. The stations that used to

        follow it have moved to rooms the customer can return to: the market

        research is a tab in the Business room, and the budget and the campaign

        kind are answered in New campaign. So from the map the business part is

        finished, and `done` is the only move — the first run goes on to connect

        an account rather than through four screens that are no longer there.


        Without this the first run had no exit that did not charge: the only

        control on the map ran the market research, which now renders somewhere

        the reader would not be sent, so ten credits bought a screen they never

        saw.'
      operationId: advance_profile_advance_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/AdvanceBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/assumptions:
    patch:
      tags:
      - Business Profile
      summary: Set Assumptions
      operationId: set_assumptions_profile_assumptions_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/AssumptionsBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/budget:
    post:
      tags:
      - Business Profile
      summary: Choose Budget
      description: The customer picks a band; Admiral's plan for it is the next screen.
      operationId: choose_budget_profile_budget_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/BudgetBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/competitors:
    post:
      tags:
      - Business Profile
      summary: Name Competitors
      description: 'Up to two competitors the customer names; Admiral reads their sites

        and looks at the market again.'
      operationId: name_competitors_profile_competitors_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/CompetitorsBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/research-country:
    post:
      tags:
      - Business Profile
      summary: Research Country
      operationId: research_country_profile_research_country_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/ResearchCountryBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/market-read:
    post:
      tags:
      - Business Profile
      summary: Market Read Endpoint
      description: 'What Admiral makes of the market it already checked.


        The numbers on that screen were bought from Google and are checkable.

        This is a reading of them, and it is labelled as one — so the rule that

        matters is that every line points at something Admiral was given. A

        sentence with no anchor beside checkable numbers does not merely fail on

        its own; it puts every number next to it in doubt.


        Charged like the rest, with the two refusals the market step taught:

        refused ABOVE the hold when there is nothing to read, and released when

        the reading cannot be anchored — because a card the customer cannot see

        is the one thing they must never pay for.'
      operationId: market_read_endpoint_profile_market_read_post
      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'
  /profile/exchange-rate:
    patch:
      tags:
      - Business Profile
      summary: Exchange Rate
      operationId: exchange_rate_profile_exchange_rate_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/ExchangeRateBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/landing-page:
    post:
      tags:
      - Business Profile
      summary: Draft Landing
      operationId: draft_landing_profile_landing_page_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/LandingPageBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /profile/landing-page/{page_id}/check:
    post:
      tags:
      - Business Profile
      summary: Check Landing
      description: 'The customer says where they published it; Admiral reads that page

        and records the two ad tags and whether it still answers the search.

        Free: it is a read of their own site, not a service.'
      operationId: check_landing_profile_landing_page__page_id__check_post
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          title: Page Id
      - 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/LandingCheckBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CompetitorsBody:
      properties:
        urls:
          items:
            type: string
          type: array
          maxItems: 2
          title: Urls
      type: object
      required:
      - urls
      title: CompetitorsBody
    LandingCheckBody:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: LandingCheckBody
    ExchangeRateBody:
      properties:
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          title: Currency
        units_per_usd:
          type: number
          maximum: 1000000.0
          exclusiveMinimum: 0.0
          title: Units Per Usd
      type: object
      required:
      - currency
      - units_per_usd
      title: ExchangeRateBody
    ClaimBody:
      properties:
        draft_id:
          type: string
          format: uuid
          title: Draft Id
      type: object
      required:
      - draft_id
      title: ClaimBody
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AssumptionsBody:
      properties:
        conversion_rate:
          type: number
          maximum: 50.0
          exclusiveMinimum: 0.0
          title: Conversion Rate
          description: Percent of clicks that become leads
      type: object
      required:
      - conversion_rate
      title: AssumptionsBody
    ConfirmBody:
      properties:
        search_terms:
          anyOf:
          - items:
              type: string
            type: array
            maxItems: 20
          - type: 'null'
          title: Search Terms
      type: object
      title: ConfirmBody
      description: 'The searches the customer kept, edited or added on the searches step.

        Absent means Admiral''s own list, as before the step existed.'
    AdvanceBody:
      properties:
        to:
          type: string
          enum:
          - summary
          - budget
          - plan
          - drafted
          - done
          title: To
      type: object
      required:
      - to
      title: AdvanceBody
    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
    CorrectionBody:
      properties:
        field:
          type: string
          enum:
          - name
          - segment
          - customer_value
          - offer
          - location
          - audience
          title: Field
        op:
          type: string
          enum:
          - set
          - remove
          title: Op
          default: set
        key:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Key
        value:
          title: Value
      type: object
      required:
      - field
      title: CorrectionBody
    LandingPageBody:
      properties:
        term:
          anyOf:
          - type: string
          - type: 'null'
          title: Term
      type: object
      title: LandingPageBody
    SegmentBody:
      properties:
        segment:
          type: string
          enum:
          - local_service
          - online_store
          - b2b
          - other
          title: Segment
      type: object
      required:
      - segment
      title: SegmentBody
    SourcesBody:
      properties:
        website_url:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Website Url
        customer_value:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Customer Value
        no_website:
          type: boolean
          title: No Website
          default: false
      type: object
      title: SourcesBody
    BudgetBody:
      properties:
        band:
          type: string
          enum:
          - under_3k
          - 3k_10k
          - 10k_50k
          title: Band
        channel:
          type: string
          enum:
          - google
          - meta
          title: Channel
          default: google
      type: object
      required:
      - band
      title: BudgetBody
    ResearchCountryBody:
      properties:
        country:
          type: string
          pattern: ^[A-Z]{2}$
          title: Country
      type: object
      required:
      - country
      title: ResearchCountryBody
    BindDraftBody:
      properties:
        account_id:
          type: string
          format: uuid
          title: Account Id
      type: object
      required:
      - account_id
      title: BindDraftBody