Get a webinar's email signatures

GET/v1/event/{eventId}/sharing/signatures

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

The email signatures your team adds before a webinar: a small banner (480×120) and a one-line invite, every link going to the registration page through the teammate's own tracked link.

banner_url is stable: it shows the "Save your seat" banner until the webinar starts and the "Watch the recording" banner after, so a signature already pasted changes by itself. stale: true means the title, date, registration link or brand changed since the signatures were made. team lists each teammate with their link, when they were emailed, opened and copied their signature, and the clicks and registrations it brought.

Webinars only (409 otherwise). Requires read:events and a user whose role on the webinar can read sharing.

Request example

cURL

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

JavaScript

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

• successboolean
• payloadSharingSignatures
  Show child attributes

  • generatedboolean
  • generated_atstring<date-time> | null
  • staleboolean
  • startedboolean
  • starts_atstring<date-time> | null
  • timezonestring | null
  • registration_urlstring | null
  • widthinteger
  • heightinteger
  • banner_urlstring | null

    Stable banner URL; "Save your seat" until the start, "Watch the recording" after.

  • bannersobject
    Show child attributes

    • livestring | null
    • on_demandstring | null
  • variantsobject[]
    Show child attributes

    • idstring

      Allowed values

      "banner", "line", "text"

    • namestring
    • htmlstring
    • textstring
  • variants_availableobject[]
    Show child attributes

    • idstring
    • namestring
  • teamobject[]
    Show child attributes

    • idstring<uuid>
    • user_idinteger
    • namestring
    • emailstring
    • share_urlstring
    • emailed_atstring<date-time> | null
    • opened_atstring<date-time> | null
    • copied_atstring<date-time> | null
    • clicksinteger
    • registrationsinteger

401

Missing, invalid or expired token.

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.

404

The event is not in the token's organization.

409

The event is not a webinar.

Response examples

200

{
  "success": true,
  "payload": {
    "generated": true,
    "generated_at": "2026-01-15T09:30:00Z",
    "stale": true,
    "started": true,
    "starts_at": "2026-01-15T09:30:00Z",
    "timezone": "<string>",
    "registration_url": "<string>",
    "width": 123,
    "height": 123,
    "banner_url": "<string>",
    "banners": {
      "live": "<string>",
      "on_demand": "<string>"
    },
    "variants": [
      {
        "id": "banner",
        "name": "<string>",
        "html": "<string>",
        "text": "<string>"
      }
    ],
    "variants_available": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "team": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "user_id": 123,
        "name": "<string>",
        "email": "<string>",
        "share_url": "<string>",
        "emailed_at": "2026-01-15T09:30:00Z",
        "opened_at": "2026-01-15T09:30:00Z",
        "copied_at": "2026-01-15T09:30:00Z",
        "clicks": 123,
        "registrations": 123
      }
    ]
  }
}