{
  "openapi": "3.0.3",
  "info": {
    "title": "Clinic Account API",
    "version": "3.0",
    "contact": {
      "email": "admin@vsee.com"
    }
  },
  "servers": [
    {
      "url": "https://api.vseepreview.com/api_v3",
      "description": "Staging"
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "samples-languages": [
      "curl",
      "python",
      "javascript",
      "java"
    ]
  },
  "paths": {
    "/accounts/{code}": {
      "get": {
        "summary": "Get account details",
        "description": "Get current member's Account data including intake forms, signup form, and workflow steps. Public access endpoint \u2014 no authentication required.\n\n### Key Response Fields\n- `Account.code` is used for starting visits and identifying the clinic.\n- `states.signup` contains the signup form schema.\n- `intake_steps` and `post_intake_steps` define the intake wizard flow.\n\n### Intake Wizard Flow\n1. Patient goes through all steps defined in `intake_steps` and `post_intake_steps` arrays.\n2. Create/update Intake object during `intake_steps`.\n3. When all `intake_steps` are passed, create a visit.\n4. Go through `post_intake_steps` where the patient may update intake, take surveys, pick pharmacy, etc.\n5. Each step has a `code` field defining the type of content.",
        "tags": [
          "Clinic Account"
        ],
        "parameters": [
          {
            "name": "code",
            "in": "path",
            "description": "Account code or dash (-) for current account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "vclinic"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "domain": {
                          "type": "string"
                        },
                        "portal_title": {
                          "type": "string"
                        },
                        "states": {
                          "type": "object"
                        },
                        "files": {
                          "type": "array"
                        },
                        "waiting_room": {
                          "type": "object"
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "Account Details": {
                    "value": {
                      "data": {
                        "id": "56ced820-55bc-43ca-9b35-4599ac1f0144",
                        "code": "vclinic",
                        "domain": "demo.vsee.me",
                        "name": "VClinic",
                        "portal_title": "",
                        "files": [
                          {
                            "file_id": "56b29a3e-a72c-49e1-93f0-4c23ac1f0144",
                            "code": "logo",
                            "path": "https://api.vsee.me/api_v3/files/56b29a3e-a72c-49e1-93f0-4c23ac1f0144"
                          }
                        ],
                        "waiting_room": {
                          "subtitle": "If this is an emergency, please call 911 or go to your nearest emergency department.",
                          "enter_text": "Enter Lounge",
                          "need_schedule": true,
                          "show_code": true,
                          "average_visit_time": 3600,
                          "capacity": 100,
                          "default_room_code": "ceproom1"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "x-auth-type": "none"
      }
    }
  }
}