Eshway Onboarding API

The Onboarding API from Eshway — 3 operation(s) for onboarding.

GitHub OpenAPI

Operations 5

POST /v1/onboarding/ensure-organization Ensure Onboarding Organization #
GET /v1/onboarding Get Onboarding #
PUT /v1/onboarding Update Onboarding #
POST /v1/onboarding Create Onboarding #
GET /v1/onboarding/status Get Onboarding Status #

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/eshway-com:eshway-com-onboarding-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.

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

OpenAPI Specification

eshway-com-onboarding-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fast Onboarding API
  version: 0.1.0
tags:
- name: Onboarding
paths:
  /v1/onboarding/ensure-organization:
    post:
      tags:
      - Onboarding
      summary: Ensure Onboarding Organization
      description: 'Onboarding-only idempotent organization creation.

        Reuses an existing org for this user + name if one exists; otherwise creates it.'
      operationId: ensure_onboarding_organization_v1_onboarding_ensure_organization_post
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: Payload
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationCreateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
  /v1/onboarding:
    get:
      tags:
      - Onboarding
      summary: Get Onboarding
      operationId: get_onboarding_v1_onboarding_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingResponse'
      security:
      - OAuth2PasswordBearer: []
    put:
      tags:
      - Onboarding
      summary: Update Onboarding
      operationId: update_onboarding_v1_onboarding_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingUpdate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
    post:
      tags:
      - Onboarding
      summary: Create Onboarding
      operationId: create_onboarding_v1_onboarding_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingCreate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
  /v1/onboarding/status:
    get:
      tags:
      - Onboarding
      summary: Get Onboarding Status
      operationId: get_onboarding_status_v1_onboarding_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: Response Get Onboarding Status V1 Onboarding Status Get
      security:
      - OAuth2PasswordBearer: []
components:
  schemas:
    OrganizationLogoUrls:
      properties:
        original:
          type: string
          title: Original
        thumbnail:
          type: string
          title: Thumbnail
        small:
          type: string
          title: Small
        medium:
          type: string
          title: Medium
        format:
          type: string
          title: Format
      type: object
      required:
      - original
      - thumbnail
      - small
      - medium
      - format
      title: OrganizationLogoUrls
    OrganizationCreateResponse:
      properties:
        name:
          type: string
          title: Name
        address:
          anyOf:
          - type: string
          - type: 'null'
          title: Address
        industry:
          anyOf:
          - type: string
          - type: 'null'
          title: Industry
        plan:
          anyOf:
          - type: string
          - type: 'null'
          title: Plan
          default: Free
        id:
          type: integer
          title: Id
        logo:
          anyOf:
          - $ref: '#/components/schemas/OrganizationLogoUrls'
          - type: 'null'
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
        message:
          type: string
          title: Message
          default: Organization created successfully
      type: object
      required:
      - name
      - id
      - created_at
      - updated_at
      title: OrganizationCreateResponse
    OnboardingResponse:
      properties:
        industry:
          type: string
          title: Industry
        team_size:
          type: string
          title: Team Size
        company_size:
          type: string
          title: Company Size
        primary_goal:
          type: string
          title: Primary Goal
        project_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Description
        project_budget:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Budget
        project_revenue:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Revenue
        focus_area:
          type: string
          title: Focus Area
        id:
          type: integer
          title: Id
        user_id:
          type: integer
          title: User Id
        completed:
          type: boolean
          title: Completed
      type: object
      required:
      - industry
      - team_size
      - company_size
      - primary_goal
      - focus_area
      - id
      - user_id
      - completed
      title: OnboardingResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OnboardingCreate:
      properties:
        industry:
          type: string
          title: Industry
        team_size:
          type: string
          title: Team Size
        company_size:
          type: string
          title: Company Size
        primary_goal:
          type: string
          title: Primary Goal
        project_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Description
        project_budget:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Budget
        project_revenue:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Revenue
        focus_area:
          type: string
          title: Focus Area
      type: object
      required:
      - industry
      - team_size
      - company_size
      - primary_goal
      - focus_area
      title: OnboardingCreate
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    OnboardingUpdate:
      properties:
        industry:
          anyOf:
          - type: string
          - type: 'null'
          title: Industry
        team_size:
          anyOf:
          - type: string
          - type: 'null'
          title: Team Size
        company_size:
          anyOf:
          - type: string
          - type: 'null'
          title: Company Size
        primary_goal:
          anyOf:
          - type: string
          - type: 'null'
          title: Primary Goal
        project_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Description
        project_budget:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Budget
        project_revenue:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Revenue
        focus_area:
          anyOf:
          - type: string
          - type: 'null'
          title: Focus Area
      type: object
      title: OnboardingUpdate
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token