Get an org contact's sessions

GET/v1/organization/{orgId}/contacts/{contactId}/sessions

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

Returns all sessions associated with a specific contact across the organization, including linked composition sources. Each session summary includes is_abstract, composition_status, and event_id. The full composition graph is not available on this lightweight endpoint.

Request example

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

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

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

import requests

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

print(response.json())

<?php

$curl = curl_init();

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

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

echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/organization/{orgId}/contacts/{contactId}/sessions", 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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/contacts/{contactId}/sessions"))
    .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

Response headers

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
contactIdstringpathrequired

Responses

200`application/json`

sessionsOrgContactSessionSummary[]
Show child attributes
- idstring<uuid>
- titlestring
- statusstring
- custom_statusstring | null
- is_abstractboolean
- composition_statusCompositionStatus
  Summary of how this session participates in a composition (merge or link). Always present on session responses.
  Show child attributes
  - rolestring
    
    standalone — normal editable record
    
    target — composite parent with one or more linked sources
    
    source — linked into another record (still editable)
    
    Allowed values
    "standalone", "target", "source"
  - is_linkedboolean
  - is_read_onlyboolean
    Always false. Linked sources stay editable; the key is kept for compatibility.
    Allowed values
    false
  - source_countinteger
    Number of records merged or linked into this session.
  - targetobject | null
    Present when role is source.
    Show child attributes
    idstring<uuid>
    friendly_idstring
    titlestring
    is_abstractboolean
- event_idinteger
  Event the session belongs to.
statusstring
Aggregated contact status derived from linked sessions (accepted, pending, or a single session's status).

401

Unauthorized

404

Contact not found

Response examples

{
  "sessions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "status": "<string>",
      "custom_status": "<string>",
      "is_abstract": true,
      "composition_status": {
        "role": "standalone",
        "is_linked": true,
        "is_read_only": false,
        "source_count": 123,
        "target": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "friendly_id": "<string>",
          "title": "<string>",
          "is_abstract": true
        }
      },
      "event_id": 123
    }
  ],
  "status": "<string>"
}