# Forsta Panel Management APIs

**Canonical:** https://apis.io/apis/forsta/panel-management/  
**Provider:** Forsta — https://apis.io/providers/forsta/  
**Base URL:** https://{server}  
**Documentation:** https://docs.developer.focusvision.com/docs/panelmanagement/integration/api

Forsta Panel Management APIs is one of 3 APIs that [Forsta](https://apis.io/providers/forsta/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Panel Management, Surveys, Market Research, Webhook, and Data Collection. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

Panel Management exposes four published contracts: an Integration API (53 operations) for sessions, panelists, notes, projects and delivery statistics; a Community API (45 operations); a webhook payload contract for panelist, survey-activity and survey-invitation events signed with ECDSA in an X-KP-Webhook-Signature header; and a vendor-callback contract an incentives partner implements for authentication, user lookup, points redemption and refunds.

## Operations (53)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/integration/sessions` | Create a new session |
| DELETE | `/api/integration/sessions/{sessionKey}` | Terminate an existing session |
| POST | `/api.pro#method=integration.campaign.createWithCommunity` | Create a campaign with community |
| POST | `/api.pro#method=integration.campaign.listing` | List scheduled campaign |
| POST | `/api.pro#method=integration.campaign.get` | Get campaign |
| POST | `/api.pro#method=integration.campaign.schedule` | Lists all samples and reminders scheduled for a campaign |
| POST | `/api.pro#method=integration.category.listing` | List all categories |
| POST | `/api.pro#method=integration.community.createSession` | Create a session by username/email address |
| POST | `/api.pro#method=integration.community.createSessionWithPID` | Create a session using the panelist pid |
| POST | `/api.pro#method=integration.community.createSessionWithIdentifier` | Creates an active session using the panelist identifier |
| POST | `/api.pro#method=integration.community.getLandingPage` | Get landing page info |
| POST | `/api.pro#method=integration.community.isUniqueOpenend` | Checks uniqueness of open end data point |
| POST | `/api.pro#method=integration.datapoint.create` | Create datapoints |
| POST | `/api.pro#method=integration.datapoint.delete` | Delete existing datapoint |
| POST | `/api.pro#method=integration.datapoint.idFromLabel` | Get datapoint by label |
| POST | `/api.pro#method=integration.panel.select` | Select current panel |
| POST | `/api.pro#method=integration.panelist.create` | Create a panelist |
| POST | `/api.pro#method=integration.panelist.read` | Read data |
| POST | `/api.pro#method=integration.panelist.update` | Update a panelist |
| POST | `/api.pro#method=integration.panelist.bulkupdate` | Update datapoints for multiple panelists |
| POST | `/api.pro#method=integration.panelist.rewardPointsAdd` | Add points |
| POST | `/api.pro#method=integration.panelist.rewardPointsDeduct` | Deduct points |
| POST | `/api.pro#method=integration.panelist.rewardPointsBalance` | Get reward point balance |
| POST | `/api.pro#method=integration.panelist.contactFrequenciesGet` | Get panelist contact frequencies |
| POST | `/api.pro#method=integration.panelist.contactFrequenciesSet` | Set the contact frequencies |
| POST | `/api.pro#method=integration.panelist.findByDataPoint` | Find Panelists by datapoint value |
| GET | `/api/integration/panels/{panelId}/panelists` | Retrieve Panelists |
| DELETE | `/api/integration/panels/{panelId}/panelists/{panelistHash}` | Delete Panelists |
| DELETE | `/api/integration/panels/{panelId}/panelists/oidc/{oidcName}/{sub}` | Delete Panelist by OIDC subject |
| GET | `/api/integration/panels/{panelId}/panelists/{panelistId}/datapoints` | Retrieve Datapoints |
| GET | `/api/integration/panels/{panelId}/activities` | Retrieve Panelist Survey Activity |
| GET | `/api/integration/panels/{panelId}/rewards` | Retrieve Panelist Survey Rewards |
| POST | `/api/integration/panels/{panelId}/panelist_datapoint_reports` | Export datapoints/system fields for a known list of panelists by identifier |
| GET | `/api/integration/panels/{panelId}/panelist_datapoint_reports/{reportId}` | Load a report by its id |
| POST | `/api.pro#method=integration.project.select` | Select a project |
| POST | `/api.pro#method=integration.project.rewards` | Get a list of rewards |
| POST | `/api.pro#method=integration.project.create` | Create a project |
| POST | `/api.pro#method=integration.project.close` | Close project |
| GET | `/api/integration/panels/{panelId}/projects/{projectId}/stats/delivery` | Project delivery statistics. |
| GET | `/api/integration/panels/{panelId}/projects/{projectId}/stats/reward` | Project reward statistics. |
| GET | `/api/integration/panels/{panelId}/projects/{projectId}/stats/activity` | Project activity statistics. |
| POST | `/api.pro#method=integration.project.listing` | List all Projects |
| POST | `/api.pro#method=integration.reminder.create` | Create a reminder |
| POST | `/api.pro#method=integration.sample.create` | Create sample |
| POST | `/api.pro#method=integration.sample.update` | Update a sample |
| POST | `/api.pro#method=integration.session.get` | Get session info using the sessionkey |
| POST | `/api.pro#method=integration.session.update` | Update the session status using the sessionkey |
| POST | `/api.pro#method=integration.surveys.available` | List survey for panelist |
| POST | `/api.pro#method=integration.token.get` | Get status of long running process |
| GET | `/api/integration/panels/{panelId}/panelists/{panelistHash}/notes` | Retrieve Notes for a given panelist. |
| POST | `/api/integration/panels/{panelId}/panelists/{panelistHash}/notes` | Create a note for a given panelist. |
| PUT | `/api/integration/panels/{panelId}/panelists/{panelistHash}/notes/{noteId}` | Change the text for a given panelist note. |
| DELETE | `/api/integration/panels/{panelId}/panelists/{panelistHash}/notes/{noteId}` | Delete a given panelist note . |

## Machine-readable artifacts (11)

- **Documentation** — https://docs.developer.focusvision.com/docs/panelmanagement/integration/api
- **APIReference** — https://docs.developer.focusvision.com/docs/panelmanagement/integration/api
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/openapi/forsta-panel-management-integration-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/openapi/forsta-panel-management-community-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/openapi/forsta-panel-management-webhooks-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/openapi/forsta-panel-management-vendor-callback-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/overlays/forsta-panel-management-integration-overlay.yaml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/overlays/forsta-panel-management-community-overlay.yaml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/overlays/forsta-panel-management-webhooks-overlay.yaml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/overlays/forsta-panel-management-vendor-callback-overlay.yaml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/asyncapi/forsta-panel-management-webhooks.yml

## Other Forsta APIs (2)

- [Forsta Decipher REST API](https://apis.io/apis/forsta/forsta/)
- [Forsta Sample Marketplace Partner APIs](https://apis.io/apis/forsta/sample-marketplace/)

## Tags

Panel Management, Surveys, Market Research, Webhook, Data Collection

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/forsta/panel-management/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/forsta/.