Admiral OAuth API
The oauth API from Admiral — 7 operation(s) for oauth.
The oauth API from Admiral — 7 operation(s) for oauth.
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-oauth-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 OAuth API
version: 0.1.0
tags:
- name: OAuth
paths:
/oauth/google/start:
post:
tags:
- OAuth
summary: Start
operationId: start_oauth_google_start_post
parameters:
- name: product
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Product
- name: account_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Account Id
- 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'
get:
tags:
- OAuth
summary: Start
operationId: getOauthGoogleStart
parameters:
- name: product
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Product
- name: account_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Account Id
- 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'
x-operation-id-source: normalized
x-operation-id-original: start_oauth_google_start_post
/oauth/google/callback:
get:
tags:
- OAuth
summary: Callback
operationId: callback_oauth_google_callback_get
parameters:
- name: code
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Code
- name: state
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: State
- name: error
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Error
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/oauth/meta/start:
post:
tags:
- OAuth
summary: Start
operationId: start_oauth_meta_start_post
parameters:
- name: account_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Account Id
- 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'
get:
tags:
- OAuth
summary: Start
operationId: getOauthMetaStart
parameters:
- name: account_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Account Id
- 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'
x-operation-id-source: normalized
x-operation-id-original: start_oauth_meta_start_post
/oauth/meta/callback:
get:
tags:
- OAuth
summary: Callback
operationId: callback_oauth_meta_callback_get
parameters:
- name: code
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Code
- name: state
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: State
- name: error
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Error
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/oauth/{provider}/selection/{selection_id}:
get:
tags:
- OAuth
summary: Read Selection
operationId: read_selection_oauth__provider__selection__selection_id__get
parameters:
- name: provider
in: path
required: true
schema:
enum:
- google
- meta
type: string
title: Provider
- name: selection_id
in: path
required: true
schema:
type: string
format: uuid
title: Selection Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- OAuth
summary: Select Accounts
operationId: select_accounts_oauth__provider__selection__selection_id__post
parameters:
- name: provider
in: path
required: true
schema:
enum:
- google
- meta
type: string
title: Provider
- name: selection_id
in: path
required: true
schema:
type: string
format: uuid
title: Selection Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SelectAccounts'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/oauth/crm/{provider}/start:
post:
tags:
- OAuth
summary: Start
operationId: start_oauth_crm__provider__start_post
parameters:
- name: provider
in: path
required: true
schema:
type: string
title: Provider
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectCRM'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/oauth/crm/{provider}/callback:
get:
tags:
- OAuth
summary: Callback
operationId: callback_oauth_crm__provider__callback_get
parameters:
- name: provider
in: path
required: true
schema:
type: string
title: Provider
- name: code
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Code
- name: state
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: State
- name: error
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Error
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ConnectCRM:
properties:
account_id:
type: string
format: uuid
title: Account Id
owner_user_id:
type: string
format: uuid
title: Owner User Id
export_new_leads:
type: boolean
title: Export New Leads
default: false
currency:
type: string
pattern: ^[A-Z]{3}$
title: Currency
type: object
required:
- account_id
- owner_user_id
- currency
title: ConnectCRM
SelectAccounts:
properties:
external_ids:
items:
type: string
type: array
maxItems: 100
minItems: 1
title: External Ids
type: object
required:
- external_ids
title: SelectAccounts
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
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError