v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB
Organizations

Submit referral source (how did you hear about us)

post/api/v1/organizations/referral-source

Request body

referral_source'search_engine' | 'ai_assistant' | 'youtube' | 'tiktok' | 'blog_article' | 'reddit' | 'hacker_news' | 'social_media' | 'word_of_mouth' | 'proxmox_community_scripts' | 'self_hosted' | 'other' | 'prefer_not_to_say' required

How a user first heard about Scanopy, as offered by the onboarding prompt.

referral_source_otherstring nullable

Free-text detail, sent when referral_source is other.

Response

Referral source recorded

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.7"
  }
}