List the products your organization owns

GET/v1/products

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

What your organization owns, so an integration or an AI assistant can tell a self-serve workspace from a Platform customer and show the right products. Read-only.

One entry per product, always in this order: platform, sessions, crm, awards, learning, marketing.

• owned: the organization can open the product now.
• via: self_serve (a self-serve plan or trial), platform (your Platform contract includes it) or null when not owned.
• days_left: whole days left on a self-serve trial, otherwise null.

platform_customer is true for an organization with a Platform contract (including every organization created before the self-serve products). Any read:* scope is enough; the answer is the organization's, the same for every key.

Request example

cURL

curl --request GET \
  --url 'https://public-api.sessionboard.com/v1/products' \
  --header 'x-access-token: <api-token>'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/products', {
  method: 'GET',
  headers: {
    "x-access-token": "<api-token>"
  },
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://public-api.sessionboard.com/v1/products",
    headers={
        "x-access-token": "<api-token>"
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/products",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/products", nil)
  req.Header.Add("x-access-token", "<api-token>")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/products"))
    .header("x-access-token", "<api-token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

GET

Send request

Authorizations

• x-access-tokenstringheader

  Organization API token. Generate from Organization Settings → API Tokens.

• AuthorizationBearer <token>headeror

  OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Responses

200application/json

OK

• appsOrganizationProduct[]required
  Show child attributes

  • keystringrequired

    Allowed values

    "platform", "sessions", "crm", "awards", "learning", "marketing"

  • ownedbooleanrequired

    The organization can open this product now.

  • viastring | nullrequired

    How the organization has it, or null when not owned.

    Allowed values

    "self_serve", "platform", null

  • days_leftinteger | nullrequired

    Whole days left on a self-serve trial, otherwise null.

• platform_customerbooleanrequired

  The organization has a Platform contract (or predates the self-serve products).

401

Unauthorized

403

The key has no read:* scope (SCOPE_REQUIRED)

Response examples

200 · A self-serve workspace (Marketing on a trial)

{
  "apps": [
    {
      "key": "platform",
      "owned": false,
      "via": null,
      "days_left": null
    },
    {
      "key": "sessions",
      "owned": false,
      "via": null,
      "days_left": null
    },
    {
      "key": "crm",
      "owned": false,
      "via": null,
      "days_left": null
    },
    {
      "key": "awards",
      "owned": false,
      "via": null,
      "days_left": null
    },
    {
      "key": "learning",
      "owned": false,
      "via": null,
      "days_left": null
    },
    {
      "key": "marketing",
      "owned": true,
      "via": "self_serve",
      "days_left": 9
    }
  ],
  "platform_customer": false
}

200 · A Platform customer whose contract includes Awards

{
  "apps": [
    {
      "key": "platform",
      "owned": true,
      "via": "platform",
      "days_left": null
    },
    {
      "key": "sessions",
      "owned": true,
      "via": "platform",
      "days_left": null
    },
    {
      "key": "crm",
      "owned": false,
      "via": null,
      "days_left": null
    },
    {
      "key": "awards",
      "owned": true,
      "via": "platform",
      "days_left": null
    },
    {
      "key": "learning",
      "owned": false,
      "via": null,
      "days_left": null
    },
    {
      "key": "marketing",
      "owned": false,
      "via": null,
      "days_left": null
    }
  ],
  "platform_customer": true
}