Forsta

Forsta Points API

The Points API from Forsta — 5 operation(s) for points.

GitHub OpenAPI

Operations 5

POST /api.pro#method=portal.points.total Get the panelist's currently available reward points #
POST /api.pro#method=portal.points.earned Get points of panelist #
POST /api.pro#method=portal.points.surveys Get the amount of points the panelist has received for completing surveys #
POST /api.pro#method=portal.points.referred Get the amount of points the panelist has received for referring other panelists #
POST /api.pro#method=portal.points.other Get points that were given to the panelist by an administrator #

Documentation

📖
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
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/rate-limits/forsta-rate-limits.yml
📖
Documentation
https://docs.developer.focusvision.com/docs/panelmanagement/integration/api
📖
APIReference
https://docs.developer.focusvision.com/docs/panelmanagement/integration/api
📖
Documentation
https://docs.developer.focusvision.com/docs/smp/contract
📖
APIReference
https://docs.developer.focusvision.com/docs/smp/contract

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/openapi/forsta-points-api-openapi.yml

Other Resources

🔗
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
🔗
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
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/asyncapi/forsta-panel-management-webhooks.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/forsta/refs/heads/main/scopes/forsta-scopes.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/forsta-points-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

forsta-points-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Panel Management Community Points API
  version: ''
servers:
- url: https://{server}
  description: Replace server with your instance domain.
  variables:
    server:
      default: staging.panel.dev.focusvision.com/
      description: Server domain
security:
- ApiKey: []
tags:
- name: Points
paths:
  /api.pro#method=portal.points.total:
    post:
      operationId: portal.points.total
      summary: Get the panelist's currently available reward points
      description: Get the panelist's currently available reward points. This total excludes any reward points already used or any pending point redemption.
      tags:
      - Points
      parameters:
      - $ref: '#/components/parameters/method'
        schema:
          enum:
          - portal.points.total
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                seskey:
                  type: string
                  description: A valid login hash.
              required:
              - seskey
            example:
              seskey: ce512c91
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/error'
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Retrieving the total points was successful.
                    points:
                      type: integer
                      description: Retrieving the panelist's current total reward points.
              examples:
                success:
                  summary: Success
                  value:
                    success: true
                    points: 1845
                error-0:
                  description: Session key is not in correct format.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session string is invalid
                    errno: '20101'
                error-1:
                  description: Session is not valid or is not found for supplied session key.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session invalid
                    errno: '30100'
                error-2:
                  description: Session has expired.
                  summary: Session expired
                  value:
                    success: false
                    error: Session expired
                    errno: '30100'
  /api.pro#method=portal.points.earned:
    post:
      operationId: portal.points.earned
      summary: Get points of panelist
      description: Get the amount of points the panelist has earned so far. This includes points from referrals, registration points and surveys.
      tags:
      - Points
      parameters:
      - $ref: '#/components/parameters/method'
        schema:
          enum:
          - portal.points.earned
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                seskey:
                  type: string
                  description: A valid login hash.
              required:
              - seskey
            example:
              seskey: ce512c91
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/error'
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Retrieving the total points was successful.
                    points:
                      type: integer
                      description: Retrieving the amount of points the panelist has earned so far.
              examples:
                success:
                  summary: Success
                  value:
                    success: true
                    points: 1845
                error-0:
                  description: Session key is not in correct format.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session string is invalid
                    errno: '20101'
                error-1:
                  description: Session is not valid or is not found for supplied session key.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session invalid
                    errno: '30100'
                error-2:
                  description: Session has expired.
                  summary: Session expired
                  value:
                    success: false
                    error: Session expired
                    errno: '30100'
  /api.pro#method=portal.points.surveys:
    post:
      operationId: portal.points.surveys
      summary: Get the amount of points the panelist has received for completing surveys
      tags:
      - Points
      parameters:
      - $ref: '#/components/parameters/method'
        schema:
          enum:
          - portal.points.surveys
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                seskey:
                  type: string
                  description: A valid login hash.
              required:
              - seskey
            example:
              seskey: ce512c91
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/error'
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Retrieving the total points was successful.
                    points:
                      type: integer
                      description: Retrieving the amount of points the panelist has received for completing surveys.
              examples:
                success:
                  summary: Success
                  value:
                    success: true
                    points: 1845
                error-0:
                  description: Session key is not in correct format.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session string is invalid
                    errno: '20101'
                error-1:
                  description: Session is not valid or is not found for supplied session key.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session invalid
                    errno: '30100'
                error-2:
                  description: Session has expired.
                  summary: Session expired
                  value:
                    success: false
                    error: Session expired
                    errno: '30100'
  /api.pro#method=portal.points.referred:
    post:
      operationId: portal.points.referred
      summary: Get the amount of points the panelist has received for referring other panelists
      tags:
      - Points
      parameters:
      - $ref: '#/components/parameters/method'
        schema:
          enum:
          - portal.points.referred
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                seskey:
                  type: string
                  description: A valid login hash.
              required:
              - seskey
            example:
              seskey: ce512c91
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/error'
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Retrieving the total points was successful.
                    points:
                      type: integer
                      description: Retrieving the amount of points the panelist has earned for referring other panelists.
              examples:
                success:
                  summary: Success
                  value:
                    success: true
                    points: 1845
                error-0:
                  description: Session key is not in correct format.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session string is invalid
                    errno: '20101'
                error-1:
                  description: Session is not valid or is not found for supplied session key.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session invalid
                    errno: '30100'
                error-2:
                  description: Session has expired.
                  summary: Session expired
                  value:
                    success: false
                    error: Session expired
                    errno: '30100'
  /api.pro#method=portal.points.other:
    post:
      operationId: portal.points.other
      summary: Get points that were given to the panelist by an administrator
      tags:
      - Points
      parameters:
      - $ref: '#/components/parameters/method'
        schema:
          enum:
          - portal.points.other
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                seskey:
                  type: string
                  description: A valid login hash.
              required:
              - seskey
            example:
              seskey: ce512c91
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/error'
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: Retrieving the total points was successful.
                    points:
                      type: integer
                      description: Retrieving the amount of points that were given to the panelist by an administrator.
              examples:
                success:
                  summary: Success
                  value:
                    success: true
                    points: 1845
                error-0:
                  description: Session key is not in correct format.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session string is invalid
                    errno: '20101'
                error-1:
                  description: Session is not valid or is not found for supplied session key.
                  summary: Session invalid
                  value:
                    success: false
                    error: Session invalid
                    errno: '30100'
                error-2:
                  description: Session has expired.
                  summary: Session expired
                  value:
                    success: false
                    error: Session expired
                    errno: '30100'
components:
  parameters:
    method:
      name: method
      in: query
      required: true
      description: Method
      schema:
        type: string
  schemas:
    error:
      type: object
      properties:
        success:
          type: boolean
        error:
          description: The error message.
          type: string
        errno:
          description: The error code.
          type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      in: query
      name: seskey
x-tagGroups:
- name: Data Input and Output
  tags:
  - Auth
  - Email
  - Panel
  - Panelist
  - Points
  - Quickpoll
  - Redemption
  - Reward
  - Survey
  - System