See what Publish would change

GET/v1/organization/{orgId}/sites/{siteId}/diff

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

The draft against what is live, in pages, blocks and settings, with one plain sentence per change in summary — show it to the person before they approve a publish. Also at GET /v1/sites/{siteId}/diff.

Request example

cURL

curl --request GET \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/sites/{siteId}/diff' \
  --header 'x-access-token: <api-token>'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/sites/{siteId}/diff', {
  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/organization/{orgId}/sites/{siteId}/diff",
    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/organization/{orgId}/sites/{siteId}/diff",
    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/organization/{orgId}/sites/{siteId}/diff", 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/organization/{orgId}/sites/{siteId}/diff"))
    .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

orgId*

siteId*

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

• orgIdstringpathrequired

  Your organization ID. Any other organization returns 404.

• siteIdstring<uuid>pathrequired

  The Site's id from List Sites.

Responses

200application/json

OK

• payloadobject
  Show child attributes

  • changedboolean
  • pagesobject[]
  • blocksobject[]
  • settingsobject[]
    Show child attributes

    • keystring
    • labelstring
  • summarystring[]

    One plain sentence per change, for the person to read.

  • revisionstring
  • has_unpublished_changesboolean

403

• SCOPE_REQUIRED — the token lacks read:sites (or read:marketing, read:learning, read:awards) for reads, or the matching write: scope for writes.
• FORBIDDEN — the token's user cannot edit this Site.

Response examples

200

{
  "payload": {
    "changed": true,
    "pages": [
      {}
    ],
    "blocks": [
      {}
    ],
    "settings": [
      {
        "key": "<string>",
        "label": "<string>"
      }
    ],
    "summary": [
      "<string>"
    ],
    "revision": "<string>",
    "has_unpublished_changes": true
  }
}