Get a webinar's share cards

GET/v1/event/{eventId}/sharing/share-cards

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

Six on-brand images (1200×627) for the weeks before a webinar: three with the speakers' faces (spotlight, lineup, portrait) and three without (headline, calendar, ticket). Each carries the title, the date and time in the webinar's time zone, the speakers and the registration link as text and a QR code. cards is empty until they are made; in_advocacy says whether a card is on the speakers' and attendees' sharing pages. stale: true means the title, date, speakers, link or brand changed since they were made. Requires read:events.

Request example

cURL

curl --request GET \
  --url 'https://public-api.sessionboard.com/v1/event/{eventId}/sharing/share-cards' \
  --header 'x-access-token: <api-token>'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/event/{eventId}/sharing/share-cards', {
  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/event/{eventId}/sharing/share-cards",
    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/event/{eventId}/sharing/share-cards",
    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/event/{eventId}/sharing/share-cards", 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/event/{eventId}/sharing/share-cards"))
    .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.

Path parameters

eventId*

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.

Path parameters

• eventIdintegerpathrequired

  The webinar's event id.

Responses

200application/json

The share cards.

• successboolean
• payloadSharingShareCards
  Show child attributes

  • cardsobject[]
    Show child attributes

    • template_idstring
    • designstring

      Allowed values

      "spotlight", "lineup", "portrait", "headline", "calendar", "ticket"

    • namestring
    • facesboolean
    • urlstring
    • widthinteger
    • heightinteger
    • in_advocacyboolean

      On the speakers' and attendees' sharing pages.

    • generated_atstring<date-time>
  • generatedboolean
  • generated_atstring<date-time> | null
  • staleboolean
  • startedboolean
  • starts_atstring<date-time> | null
  • timezonestring | null
  • speakersinteger
  • speakers_with_photosinteger
  • registration_urlstring | null
  • designsobject[]
    Show child attributes

    • idstring
    • namestring
    • facesboolean

403

• SCOPE_REQUIRED: the token lacks read:events (reads) or write:marketing (writes).
• EVENT_NOT_ALLOWED: the event is outside the token's event allow-list.
• Otherwise the token's user cannot read (or edit) sharing on this webinar.

409

The event is not a webinar.

Response examples

200

{
  "success": true,
  "payload": {
    "cards": [
      {
        "template_id": "<string>",
        "design": "spotlight",
        "name": "<string>",
        "faces": true,
        "url": "<string>",
        "width": 123,
        "height": 123,
        "in_advocacy": true,
        "generated_at": "2026-01-15T09:30:00Z"
      }
    ],
    "generated": true,
    "generated_at": "2026-01-15T09:30:00Z",
    "stale": true,
    "started": true,
    "starts_at": "2026-01-15T09:30:00Z",
    "timezone": "<string>",
    "speakers": 123,
    "speakers_with_photos": 123,
    "registration_url": "<string>",
    "designs": [
      {
        "id": "<string>",
        "name": "<string>",
        "faces": true
      }
    ]
  }
}