Developer Overview · Integration Overview

The API covers Sway's core functionality — creating profiles, generating assessment codes, deep-linking into a test, and retrieving results and PDFs — for integrating Sway with your own application or EMR.

Quick Reference

1. What You Can Do Today

A focused set of endpoints, with more planned.

• Create & manage profiles: Create, update and look up patient/athlete profiles in your organization.
• Generate assessment codes: Mint screening / baseline codes that assign a specific protocol and test.
• Deep link into a test: Open the Sway app directly into an assigned test via a universal link (iOS & Android).
• Download clinical PDFs: Pull the Clinical Report PDF for a profile's latest test as a file download.
• Get raw results: Retrieve structured numeric scores, percentiles and full test history as JSON.
• Read protocols & measures: List the protocols and measures (test types) configured for your organization.

2. Endpoints at a Glance

All endpoints are POST with a JSON body (one GET exception). IDs accept a ProfileId (int) or UniqueId (GUID).

Profiles

Profile Detail & Results

Codes & Assessments

Protocols, Measures & Utility

Choosing a Code Type on CreateCode

BaselineSessionTypeId is effectively the code type — despite the name it does not control baselines (that's the separate isNonBaseline flag). It sets the test format and how the profile is handled:

• Single Test → a Screening in the Sway app: one of each test type in the protocol.
• Session → a full Assessment: three of each test type, plus practice.
• New… → prompts the user to enter their info (creates the profile).
• Existing… → tied to the ProfileId you pass; goes straight into testing.

3. Common Integration Patterns

Two low-lift patterns teams commonly start with.

Pull-Based · EMR Sync: Nightly Results into Your EMR

1. Setup: Paste your Sway API key into your EMR.
2. Match: Call GetAllProfiles and match Sway profiles to patient records, saving the Sway ID. (Single profiles can also be copy/pasted for one-off fixes.)
3. Sync: Each night, use lastTestDate to find patients tested in the last 24h, then pull the latest GetProfileLatestTestPdf (or raw results via GetProfileDetail).

Deep Link · In-App Testing: Send a Patient Straight into a Test

1. Your server: Call CreateProfile with the details you already have — height, weight, DOB, etc.
2. Your server: Call CreateCode with the ProfileId, protocol and test details (create as many as you like per profile).
3. Your app: Show a "Take Sway Test" button to the universal deep link with your code and a return URL:

https://portal.swaymedical.com/gotoapp/takebaseline?baselineCode={code}&callbackUrl={callbackUrl}

4. Your app: On return, call GetProfileDetail or GetProfileLatestTestPdf to retrieve the results.

4. Getting Started

From zero to your first authenticated call.

1. We enable API access for your organization.
2. Generate your key. In portal.swaymedical.com → Organization (left menu) → API Key tab. An admin account is required.
3. Authenticate every request with your key — either the X-ApiKey header or an apiKey field in the JSON body.
4. Explore & try it out. Browse endpoints and schemas at api.swaymedical.com — no key needed to read. With a key you can run requests right from the page.
5. Generate a typed client. The OpenAPI definition is NSwag-friendly — generate a C# (or any-language) client from /swagger/v1/swagger.json.

Authentication

Send the key one way or the other. Each key is scoped to a single organization, so every call is automatically tenant-isolated.

Additional Information

Additional API options are available for custom integrations — discuss with your sales rep.

Contact your Sway Medical representative to enable API access for your organization.

Sway Medical · External API · Last updated June 2026