# Forsta Panelist API

**Canonical:** https://apis.io/apis/forsta/forsta-panelist-api/  
**Provider:** Forsta — https://apis.io/providers/forsta/  
**Base URL:** https://{server}/api/v1  
**Documentation:** https://docs.developer.focusvision.com/docs/decipher/api

Forsta Panelist API is one of 120 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 Panelist. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

The Panelist API from Forsta — 26 operation(s) for panelist.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| POST | `/api.pro#method=portal.panelist.create` | Create a new panelist |
| POST | `/api.pro#method=portal.panelist.update` | Update the current panelist's information |
| POST | `/api.pro#method=portal.panelist.optOut` | Unsubscribes a panelist |
| POST | `/api.pro#method=portal.panelist.read` | Panelist information |
| POST | `/api.pro#method=portal.panelist.confirm` | Confirms panelist join to the panel |
| POST | `/api.pro#method=portal.panelist.referralHash` | Returns the referral hash |
| POST | `/api.pro#method=portal.panelist.contactFrequenciesGet` | Gets the currently set panelist contact frequencies |
| POST | `/api.pro#method=portal.panelist.contactFrequenciesSet` | Set the contact frequencies for the current panelist |
| 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 |

## Machine-readable artifacts (16)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/openapi/forsta-panelist-api-openapi.yml
- **Documentation** — https://docs.developer.focusvision.com/docs/decipher/api
- **APIReference** — https://docs.developer.focusvision.com/docs/decipher/api
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/authentication/forsta-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/conventions/forsta-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/errors/forsta-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/data-model/forsta-data-model.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/rate-limits/forsta-rate-limits.yml
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/sandbox/forsta-sandbox.yml
- **CLI** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/cli/forsta-cli.yml
- **Documentation** — https://docs.developer.focusvision.com/docs/panelmanagement/integration/api
- **APIReference** — https://docs.developer.focusvision.com/docs/panelmanagement/integration/api
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/asyncapi/forsta-panel-management-webhooks.yml
- **Documentation** — https://docs.developer.focusvision.com/docs/smp/contract
- **APIReference** — https://docs.developer.focusvision.com/docs/smp/contract
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/scopes/forsta-scopes.yml

## Other Forsta APIs (12)

- [Forsta Abandon Section API](https://apis.io/apis/forsta/forsta-abandon-section-api/)
- [Forsta API Keys API](https://apis.io/apis/forsta/forsta-api-keys-api/)
- [Forsta API Spec API](https://apis.io/apis/forsta/forsta-apispec-api/)
- [Forsta App API](https://apis.io/apis/forsta/forsta-app-api/)
- [Forsta Archival Reports API](https://apis.io/apis/forsta/forsta-archival-reports-api/)
- [Forsta Archives API](https://apis.io/apis/forsta/forsta-archives-api/)
- [Forsta Augeo Callback API](https://apis.io/apis/forsta/forsta-augeo-callback-api/)
- [Forsta Auth API](https://apis.io/apis/forsta/forsta-auth-api/)
- [Forsta Autoclose API](https://apis.io/apis/forsta/forsta-autoclose-api/)
- [Forsta Available Project Parameters API](https://apis.io/apis/forsta/forsta-available-project-parameters-api/)
- [Forsta Available Sections API](https://apis.io/apis/forsta/forsta-available-sections-api/)
- [Forsta Bounced Emails API](https://apis.io/apis/forsta/forsta-bounced-emails-api/)

## Tags

Panelist

---

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