Admiral Leads API

The leads API from Admiral — 21 operation(s) for leads.

GitHub OpenAPI

Operations 24

GET /leads List Leads #
GET /leads/{lead_id} Get Lead #
PATCH /leads/{lead_id} Update Lead #
PATCH /leads/{lead_id}/contact Update Contact #
POST /leads/import-csv Import Csv #
POST /leads/import Import Leads #
GET /leads/test Test Enquiry State #
POST /leads/test Send Test Enquiry #
GET /lead-connections Connections #
GET /lead-connections/meta/{account_id}/pages Pages #
GET /lead-connections/meta/{account_id}/forms/{page_id} Forms #
POST /lead-connections/hubspot/oauth Connect Hubspot Oauth #
POST /lead-connections/meta Connect Meta #
POST /lead-connections/hubspot Connect Hubspot #
POST /lead-connections/{connection_id}/sync Sync #
DELETE /lead-connections/{connection_id} Disconnect #
POST /lead-connections/salesforce Connect Salesforce #
GET /lead-connections/{connection_id}/exports Exports #
POST /lead-connections/{connection_id}/exports/{lead_id} Export Lead #
GET /lead-connections/privacy/list Privacy Connections #
POST /lead-connections/{connection_id}/exports/{lead_id}/reconcile Reconcile Export #
GET /leads/{lead_id}/followups List Followups #
POST /leads/{lead_id}/followups Approve #
DELETE /leads/{lead_id}/followups/{followup_id} Cancel #

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-leads-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-leads-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Admiral Leads API
  version: 0.1.0
tags:
- name: Leads
paths:
  /leads:
    get:
      tags:
      - Leads
      summary: List Leads
      operationId: list_leads_leads_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      - name: source
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /leads/{lead_id}:
    get:
      tags:
      - Leads
      summary: Get Lead
      operationId: get_lead_leads__lead_id__get
      parameters:
      - name: lead_id
        in: path
        required: true
        schema:
          type: integer
          title: Lead Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Leads
      summary: Update Lead
      operationId: update_lead_leads__lead_id__patch
      parameters:
      - name: lead_id
        in: path
        required: true
        schema:
          type: integer
          title: Lead Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadOutcome'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /leads/{lead_id}/contact:
    patch:
      tags:
      - Leads
      summary: Update Contact
      operationId: update_contact_leads__lead_id__contact_patch
      parameters:
      - name: lead_id
        in: path
        required: true
        schema:
          type: integer
          title: Lead Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadContact'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /leads/import-csv:
    post:
      tags:
      - Leads
      summary: Import Csv
      operationId: import_csv_leads_import_csv_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CSVImport'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /leads/import:
    post:
      tags:
      - Leads
      summary: Import Leads
      operationId: import_leads_leads_import_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadImport'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /leads/test:
    get:
      tags:
      - Leads
      summary: Test Enquiry State
      operationId: test_enquiry_state_leads_test_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    post:
      tags:
      - Leads
      summary: Send Test Enquiry
      operationId: send_test_enquiry_leads_test_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /lead-connections:
    get:
      tags:
      - Leads
      summary: Connections
      operationId: connections_lead_connections_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /lead-connections/meta/{account_id}/pages:
    get:
      tags:
      - Leads
      summary: Pages
      operationId: pages_lead_connections_meta__account_id__pages_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'
  /lead-connections/meta/{account_id}/forms/{page_id}:
    get:
      tags:
      - Leads
      summary: Forms
      operationId: forms_lead_connections_meta__account_id__forms__page_id__get
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          title: Page Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/hubspot/oauth:
    post:
      tags:
      - Leads
      summary: Connect Hubspot Oauth
      operationId: connect_hubspot_oauth_lead_connections_hubspot_oauth_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HubSpotOAuthConnect'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/meta:
    post:
      tags:
      - Leads
      summary: Connect Meta
      operationId: connect_meta_lead_connections_meta_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetaConnect'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/hubspot:
    post:
      tags:
      - Leads
      summary: Connect Hubspot
      operationId: connect_hubspot_lead_connections_hubspot_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HubSpotConnect'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/{connection_id}/sync:
    post:
      tags:
      - Leads
      summary: Sync
      operationId: sync_lead_connections__connection_id__sync_post
      parameters:
      - name: connection_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Connection Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/{connection_id}:
    delete:
      tags:
      - Leads
      summary: Disconnect
      operationId: disconnect_lead_connections__connection_id__delete
      parameters:
      - name: connection_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Connection Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/salesforce:
    post:
      tags:
      - Leads
      summary: Connect Salesforce
      operationId: connect_salesforce_lead_connections_salesforce_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SalesforceConnect'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/{connection_id}/exports:
    get:
      tags:
      - Leads
      summary: Exports
      operationId: exports_lead_connections__connection_id__exports_get
      parameters:
      - name: connection_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Connection Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/{connection_id}/exports/{lead_id}:
    post:
      tags:
      - Leads
      summary: Export Lead
      operationId: export_lead_lead_connections__connection_id__exports__lead_id__post
      parameters:
      - name: connection_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Connection Id
      - name: lead_id
        in: path
        required: true
        schema:
          type: integer
          title: Lead Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lead-connections/privacy/list:
    get:
      tags:
      - Leads
      summary: Privacy Connections
      operationId: privacy_connections_lead_connections_privacy_list_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /lead-connections/{connection_id}/exports/{lead_id}/reconcile:
    post:
      tags:
      - Leads
      summary: Reconcile Export
      operationId: reconcile_export_lead_connections__connection_id__exports__lead_id__reconcile_post
      parameters:
      - name: connection_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Connection Id
      - name: lead_id
        in: path
        required: true
        schema:
          type: integer
          title: Lead Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /leads/{lead_id}/followups:
    get:
      tags:
      - Leads
      summary: List Followups
      operationId: list_followups_leads__lead_id__followups_get
      parameters:
      - name: lead_id
        in: path
        required: true
        schema:
          type: integer
          title: Lead Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Leads
      summary: Approve
      operationId: approve_leads__lead_id__followups_post
      parameters:
      - name: lead_id
        in: path
        required: true
        schema:
          type: integer
          title: Lead Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApproveFollowup'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /leads/{lead_id}/followups/{followup_id}:
    delete:
      tags:
      - Leads
      summary: Cancel
      operationId: cancel_leads__lead_id__followups__followup_id__delete
      parameters:
      - name: lead_id
        in: path
        required: true
        schema:
          type: integer
          title: Lead Id
      - name: followup_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Followup 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
    MetaConnect:
      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
        page_id:
          type: string
          pattern: ^\d{1,40}$
          title: Page Id
        form_id:
          type: string
          pattern: ^\d{1,40}$
          title: Form Id
      type: object
      required:
      - account_id
      - owner_user_id
      - page_id
      - form_id
      title: MetaConnect
    ApproveFollowup:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        subject:
          type: string
          maxLength: 200
          minLength: 1
          title: Subject
        body:
          type: string
          maxLength: 10000
          minLength: 1
          title: Body
        send_at:
          type: string
          format: date-time
          title: Send At
      type: object
      required:
      - id
      - subject
      - body
      - send_at
      title: ApproveFollowup
    CSVImport:
      properties:
        csv:
          type: string
          maxLength: 250000
          minLength: 1
          title: Csv
      type: object
      required:
      - csv
      title: CSVImport
    LeadOutcome:
      properties:
        status:
          type: string
          enum:
          - new
          - contacted
          - qualified
          - won
          - lost
          title: Status
          default: new
        owner_user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Owner User Id
        next_action:
          anyOf:
          - type: string
            maxLength: 1000
          - type: 'null'
          title: Next Action
        next_action_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Next Action At
        revenue_minor:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Revenue Minor
        revenue_currency:
          anyOf:
          - type: string
            pattern: ^[A-Z]{3}$
          - type: 'null'
          title: Revenue Currency
        outcome_note:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Outcome Note
      type: object
      title: LeadOutcome
    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
    LeadContact:
      properties:
        email:
          anyOf:
          - type: string
            maxLength: 254
          - type: 'null'
          title: Email
        phone:
          anyOf:
          - type: string
            maxLength: 80
          - type: 'null'
          title: Phone
        name:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Name
        company:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Company
      type: object
      title: LeadContact
    ImportLead:
      properties:
        email:
          type: string
          maxLength: 254
          title: Email
        name:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Name
        company:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Company
        utm_campaign:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Utm Campaign
        utm_source:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Utm Source
      type: object
      required:
      - email
      title: ImportLead
    LeadImport:
      properties:
        rows:
          items:
            $ref: '#/components/schemas/ImportLead'
          type: array
          maxItems: 500
          minItems: 1
          title: Rows
      type: object
      required:
      - rows
      title: LeadImport
    SalesforceConnect:
      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
        instance_url:
          type: string
          maxLength: 250
          title: Instance Url
        client_id:
          type: string
          format: password
          title: Client Id
          writeOnly: true
        client_secret:
          type: string
          format: password
          title: Client Secret
          writeOnly: true
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          title: Currency
      type: object
      required:
      - account_id
      - owner_user_id
      - instance_url
      - client_id
      - client_secret
      - currency
      title: SalesforceConnect
    HubSpotOAuthConnect:
      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
        client_id:
          type: string
          format: password
          title: Client Id
          writeOnly: true
        client_secret:
          type: string
          format: password
          title: Client Secret
          writeOnly: true
        refresh_token:
          type: string
          format: password
          title: Refresh Token
          writeOnly: true
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          title: Currency
      type: object
      required:
      - account_id
      - owner_user_id
      - client_id
      - client_secret
      - refresh_token
      - currency
      title: HubSpotOAuthConnect
    HubSpotConnect:
      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
        token:
          type: string
          format: password
          title: Token
          writeOnly: true
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          title: Currency
      type: object
      required:
      - account_id
      - owner_user_id
      - token
      - currency
      title: HubSpotConnect