API Documentation

The Pathos Panel API gives you full programmatic access to manage panelists, distribute surveys, process rewards, and access analytics. All endpoints return JSON and use standard HTTP response codes.

Quick Start

Include your API token in the Authorization header of every request:

curl -X GET https://api.pathospanel.com/v1/panelists \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Authentication

All API requests require a Bearer token. Generate API keys from your admin dashboard under Settings → API Keys.

Panelists

Manage your panel members — create, update, search, and manage panelist profiles and their engagement data.

Surveys

Create and manage survey distributions, quotas, and panelist routing.

Rewards

Manage reward catalog, redemptions, and point transactions.

Analytics

Access panel health metrics, engagement data, and reporting endpoints.

Webhooks

Receive real-time notifications when events occur in your panel.

White-Label

Configure custom domains, email gateway (BYO SMTP), stealth mode, support routing, SSO/SAML, and branded API documentation for your tenant.

Available Webhook Events

Event	Description
`panelist.created`	A new panelist has registered or been created via API
`panelist.updated`	A panelist's profile has been modified
`panelist.deactivated`	A panelist has been deactivated or suspended
`survey.completed`	A panelist has completed a survey
`survey.screened_out`	A panelist was screened out of a survey
`reward.redeemed`	A panelist has redeemed a reward
`referral.completed`	A referral has resulted in a new active panelist
`fraud.detected`	A fraud signal has been triggered
`tier.changed`	A panelist's tier has changed

Integration Guides

Connect Pathos Panel with your preferred survey platform. Each integration uses redirect URLs to track survey completions, terminations, and quota-full events.

How Survey Integration Works

1. Route

Panelist clicks survey link in Pathos Panel dashboard

2. Survey

Panelist is redirected to your survey tool with a unique session ID

3. Callback

Survey tool redirects back to Pathos Panel with completion status

4. Reward

Pathos Panel awards points and updates project stats

Redirect / Callback URLs

Configure these URLs in your survey tool to redirect panelists back to Pathos Panel after they finish (or are screened out of) your survey:

Complete

https://app.pathospanel.com/survey/complete?sid=[SESSION_ID]&status=complete

Terminate / Screenout

https://app.pathospanel.com/survey/terminate?sid=[SESSION_ID]&status=terminate

Quota Full

https://app.pathospanel.com/survey/quota-full?sid=[SESSION_ID]&status=quota_full

SurveyMonkey

Step 1: Create your survey in SurveyMonkey

Design your questionnaire as you normally would.

Step 2: Enable Custom Variables

Go to Collect → Web Link → Custom Variables and add a variable named sid.

Step 3: Configure Redirect URLs

Under Collect → Web Link → Survey end page, select "Redirect to your own webpage" and enter:

Complete: https://app.pathospanel.com/survey/complete?sid=[sid_value]&status=complete
Disqualify: https://app.pathospanel.com/survey/terminate?sid=[sid_value]&status=terminate
Quota: https://app.pathospanel.com/survey/quota-full?sid=[sid_value]&status=quota_full

Step 4: Create Project in Pathos Panel

Use your SurveyMonkey collector URL as the survey URL, with ?sid={SESSION_ID} appended.

https://www.surveymonkey.com/r/YOURSURVEY?sid={SESSION_ID}

Qualtrics

Step 1: Add Embedded Data

In your Survey Flow, add an Embedded Data element at the top with a field named sid.

Step 2: Configure End-of-Survey Redirect

Go to Survey options → Survey termination → Custom end-of-survey message. Use "Redirect to a URL" and pipe the Embedded Data:

Complete URL:
https://app.pathospanel.com/survey/complete?sid=${e://Field/sid}&status=complete

Screenout URL (Survey Flow > Branch Logic > End of Survey element):
https://app.pathospanel.com/survey/terminate?sid=${e://Field/sid}&status=terminate

Quota Full URL (Quotas > Over Quota Options):
https://app.pathospanel.com/survey/quota-full?sid=${e://Field/sid}&status=quota_full

Step 3: Create Project in Pathos Panel

Use your Qualtrics distribution link as the survey URL:

https://yourorg.qualtrics.com/jfe/form/SV_XXXX?sid={SESSION_ID}

Alchemer (SurveyGizmo)

Step 1: Add URL Variable

Go to Tools → URL Variables and create a variable named sid.

Step 2: Configure Redirect Actions

In Survey Settings → Results → Redirect Upon Completion:

Complete redirect:
https://app.pathospanel.com/survey/complete?sid=[url("sid")]&status=complete

For Disqualify/Screenout pages, add a URL Redirect action:
https://app.pathospanel.com/survey/terminate?sid=[url("sid")]&status=terminate

For Quota actions:
https://app.pathospanel.com/survey/quota-full?sid=[url("sid")]&status=quota_full

Step 3: Create Project in Pathos Panel

Use your Alchemer survey link with the sid parameter:

https://survey.alchemer.com/s3/XXXXXXX/YourSurvey?sid={SESSION_ID}

Data Exports

Export data as CSV from the admin dashboard or via API. All exports are audit-logged for SOC 2 compliance.

GET

/api/admin/panelists/export

Export all panelists with demographics, scores, and status

GET

/api/admin/projects/export

Export all projects with quota rollups and response counts

GET

/api/admin/projects/:id/responses/export

Export survey responses for a specific project

GET

/api/admin/logs/export

Export audit trail as CSV (SOC 2 evidence)

Need help integrating?

Our engineering team is here to help you get up and running.

Contact API Support