Admiral Accounts API

The accounts API from Admiral — 16 operation(s) for accounts.

GitHub OpenAPI

Operations 16

GET /accounts List Accounts #
GET /accounts/privacy Privacy Accounts #
POST /accounts/connect-mcc Connect Mcc #
GET /accounts/mcc-tree Mcc Tree #
POST /accounts/{account_id}/frequency Set Frequency #
PATCH /accounts/{account_id}/voice-settings Set Voice Settings #
POST /accounts/{account_id}/activate Activate #
POST /accounts/{account_id}/disconnect Disconnect #
DELETE /accounts/{account_id} Delete Account #
POST /accounts/{account_id}/sync Sync Now #
GET /accounts/{account_id}/sync-status Sync Status #
GET /accounts/{account_id}/budget-status Budget Status #
GET /accounts/{account_id}/timeseries Timeseries #
GET /accounts/{account_id}/recommendations Recommendations #
POST /accounts/{account_id}/recommendations/{rec_id}/apply Apply Recommendation #
POST /accounts/{account_id}/recommendations/{rec_id}/dismiss Dismiss Recommendation #

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-accounts-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-accounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Admiral Accounts API
  version: 0.1.0
tags:
- name: Accounts
paths:
  /accounts:
    get:
      tags:
      - Accounts
      summary: List Accounts
      operationId: list_accounts_accounts_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /accounts/privacy:
    get:
      tags:
      - Accounts
      summary: Privacy Accounts
      operationId: privacy_accounts_accounts_privacy_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /accounts/connect-mcc:
    post:
      tags:
      - Accounts
      summary: Connect Mcc
      operationId: connect_mcc_accounts_connect_mcc_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectMccRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/mcc-tree:
    get:
      tags:
      - Accounts
      summary: Mcc Tree
      description: 'Operator-only enumeration using Admiral''s shared manager credential.


        Customer connections use their own OAuth authorization. Being signed in

        to Admiral does not grant access to the shared manager''s client accounts.'
      operationId: mcc_tree_accounts_mcc_tree_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /accounts/{account_id}/frequency:
    post:
      tags:
      - Accounts
      summary: Set Frequency
      operationId: set_frequency_accounts__account_id__frequency_post
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FrequencyRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/voice-settings:
    patch:
      tags:
      - Accounts
      summary: Set Voice Settings
      description: 'Talk voice settings. voice_provider survives as an internal routing

        override (ops/debug) — the UI no longer offers it; users choose a

        LANGUAGE and routing follows. The language must be one Admiral can

        actually speak: an unlisted tag would silently mis-transcribe the whole

        call, which is exactly the failure this allowlist exists to prevent.'
      operationId: set_voice_settings_accounts__account_id__voice_settings_patch
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoiceSettingsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/activate:
    post:
      tags:
      - Accounts
      summary: Activate
      description: 'Activate syncing for an account. Connecting never requires a budget —

        an account with no live spend still connects and syncs; the cockpit shows

        a soft ''add budget to start getting leads'' nudge instead of blocking.'
      operationId: activate_accounts__account_id__activate_post
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/disconnect:
    post:
      tags:
      - Accounts
      summary: Disconnect
      description: 'Disconnect an ad account: syncing stops and the stored login is

        deleted. This is the privacy policy''s "disconnect from Settings" —

        distinct from account deletion, so already-synced data stays visible.

        The scheduler never dispatches a disconnected account, and the billing

        ceiling frees the seat (connected_accounts excludes this status).

        Reconnecting is the normal OAuth flow; the provider-side grant can only

        be fully revoked on the provider''s own permissions page.'
      operationId: disconnect_accounts__account_id__disconnect_post
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}:
    delete:
      tags:
      - Accounts
      summary: Delete Account
      description: 'Remove an account from Admiral completely — every synced row, every

        receipt, the account itself. The ad account on the provider''s side is

        untouched. Gated behind disconnect so nobody deletes a live, syncing

        account in one click.'
      operationId: delete_account_accounts__account_id__delete
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/sync:
    post:
      tags:
      - Accounts
      summary: Sync Now
      description: Kick an immediate snapshot for this account (no-op if one is running).
      operationId: sync_now_accounts__account_id__sync_post
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/sync-status:
    get:
      tags:
      - Accounts
      summary: Sync Status
      operationId: sync_status_accounts__account_id__sync_status_get
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/budget-status:
    get:
      tags:
      - Accounts
      summary: Budget Status
      description: 'Advisory only: does the account have any enabled campaign with a budget?

        Drives the cockpit nudge — never gates connection or syncing.'
      operationId: budget_status_accounts__account_id__budget_status_get
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/timeseries:
    get:
      tags:
      - Accounts
      summary: Timeseries
      description: 'True daily performance from GAQL segments.date — account totals per day

        plus per-campaign period totals. Backfilled 30 days on the first sync.'
      operationId: timeseries_accounts__account_id__timeseries_get
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      - name: days
        in: query
        required: false
        schema:
          type: integer
          default: 30
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/recommendations:
    get:
      tags:
      - Accounts
      summary: Recommendations
      description: The proposals queue, in the shape the cockpit has always consumed.
      operationId: recommendations_accounts__account_id__recommendations_get
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/recommendations/{rec_id}/apply:
    post:
      tags:
      - Accounts
      summary: Apply Recommendation
      operationId: apply_recommendation_accounts__account_id__recommendations__rec_id__apply_post
      parameters:
      - name: rec_id
        in: path
        required: true
        schema:
          type: string
          title: Rec Id
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/ApplyBody'
              - 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'
  /accounts/{account_id}/recommendations/{rec_id}/dismiss:
    post:
      tags:
      - Accounts
      summary: Dismiss Recommendation
      operationId: dismiss_recommendation_accounts__account_id__recommendations__rec_id__dismiss_post
      parameters:
      - name: rec_id
        in: path
        required: true
        schema:
          type: string
          title: Rec Id
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      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
    FrequencyRequest:
      properties:
        frequency:
          anyOf:
          - type: string
          - type: 'null'
          title: Frequency
        tier:
          anyOf:
          - type: string
          - type: 'null'
          title: Tier
      type: object
      title: FrequencyRequest
    ApplyBody:
      properties:
        thread_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Thread Id
        apply_over:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Apply Over
      type: object
      title: ApplyBody
    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
    VoiceSettingsRequest:
      properties:
        voice_enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Voice Enabled
        voice_provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Voice Provider
        voice_language:
          anyOf:
          - type: string
          - type: 'null'
          title: Voice Language
      type: object
      title: VoiceSettingsRequest
    ConnectMccRequest:
      properties:
        customer_id:
          type: string
          title: Customer Id
        name:
          type: string
          title: Name
          default: ''
      type: object
      required:
      - customer_id
      title: ConnectMccRequest