GroundRoute AI

GroundRoute AI Referral API

The referral API from GroundRoute AI — 1 operation(s) for referral.

GitHub OpenAPI

Operations 1

GET /v1/console/referral Get Referral #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/groundroute-ai/openapi/groundroute-ai-referral-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-shim-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-workspace-settings-update-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-workspace-settings-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-tenant-drill-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-overview-schema.json
📊
JSONSchema
https://artifacts.apis.io/groundroute-ai/json-schema/groundroute-ai-tenant-row-schema.json

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/groundroute-ai:groundroute-ai-referral-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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

groundroute-ai-referral-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GroundRoute Referral API
  version: 0.3.0
tags:
- name: Referral
paths:
  /v1/console/referral:
    get:
      tags:
      - Referral
      summary: Get Referral
      operationId: get_referral_v1_console_referral_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralView'
components:
  schemas:
    ReferralView:
      properties:
        code:
          type: string
          title: Code
        link_url:
          type: string
          title: Link Url
        invited:
          type: integer
          title: Invited
        qualified:
          type: integer
          title: Qualified
        active_discount_share:
          type: number
          title: Active Discount Share
        effective_gain_share:
          type: number
          title: Effective Gain Share
        headroom_to_floor:
          type: number
          title: Headroom To Floor
        welcome_active:
          type: boolean
          title: Welcome Active
        welcome_ends_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Welcome Ends At
      additionalProperties: false
      type: object
      required:
      - code
      - link_url
      - invited
      - qualified
      - active_discount_share
      - effective_gain_share
      - headroom_to_floor
      - welcome_active
      - welcome_ends_at
      title: ReferralView