Puzzle Onboarding API

The Onboarding API from Puzzle — 1 operation(s) for onboarding.

Operations 1

POST /onboarding Initiate Prefilled Onboarding #

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/puzzle-onboarding-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

puzzle-onboarding-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Puzzle Onboarding API
  description: Puzzle Api
  version: '0'
servers:
- url: https://staging.southparkdata.com/rest/v0
tags:
- name: Onboarding
paths:
  /onboarding:
    post:
      operationId: initiatePrefilledOnboarding
      summary: Initiate Prefilled Onboarding
      description: Call this endpoint to pass some company information that is usually asked for during Puzzle's onboarding flow. A URL will be returned. When you redirect your user to this URL, the company information that was passed the original request will be prefilled for them in Puzzle's UI, allowing them to skip a few steps and create their Puzzle account more quickly.
      tags:
      - Onboarding
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                type:
                  type: string
                  enum:
                  - SAAS
                  - ECOMMERCE
                  - MARKETPLACE
                  - ADVERTISING
                  - SERVICES
                  - ENTERPRISE
                  - FINTECH
                  - FINTECH_CRYPTO
                  - VIRTUAL_GOODS
                  - CONSUMER
                  - NOT_SURE
                  - OTHER
                  - AGRICULTURE_AND_FARMING
                  - CONSTRUCTION
                  - HEALTHCARE
                  - HOME_SERVICES
                  - LEGAL
                  - MANUFACTURING
                  - MEDIA_AND_ENTERTAINMENT
                  - PROFESSIONAL_SERVICES
                  - RETAIL
                  - REAL_ESTATE
                  - RESTAURANT
                  - TRANSPORTATION
                  - WHOLESALE_TRADE
                  description: The value is normalized before matching, so any casing that maps onto a listed value is accepted.
                timeZone:
                  type: string
                  minLength: 1
                currentUserRole:
                  type: string
                  enum:
                  - Founder
                  - CompanyEmployee
                  - OutsourcedAccountantOrCFO
                orgType:
                  type: string
                  enum:
                  - CCorporation
                  - LLC
                  - Partnership
                  - SCorporation
                  - SoleProprietorship
                revenueModel:
                  type: string
                  enum:
                  - AnnualSubscription
                  - MonthlySubscription
                  - MultipleRevenueModels
                  - NotSure
                  - PreRevenue
                  - ServiceBased
                  - TransactionBased
                  - UsageBased
                  - Subscription
                  - AddOns
                  - TransactionBasedPhysical
                  - TransactionBasedOther
                  - Contracts
                  - HourlyBilling
                  - Marketplace
                  - Commission
                hasHistoricalData:
                  type: boolean
                phoneNumber:
                  type: string
                connectionInfo:
                  type: object
                  properties:
                    nativeCompanyId:
                      type: string
                      minLength: 1
                    authForwardToken:
                      type: string
                    createPushIntegrationConnection:
                      type: boolean
                  required:
                  - nativeCompanyId
              required:
              - name
              - type
              - timeZone
              - currentUserRole
              - orgType
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                required:
                - url