Introduction

The SAM Web Service provides a comprehensive REST API for managing users, events, content, notifications, and reference data across the platform.

Base URL

All endpoints are served over HTTPS only (port 443). HTTP on port 80 is disabled.

https://<host>/rest/…

Authentication

Most endpoints require an auth token obtained via loginUser. Pass it in the request header:

x-nextinteract-authtoken: <token>

Auth tokens are valid for 30 minutes with a 30-second renewal window before expiry. See Authentication & Security for full details.

Conventions

Aspect	Detail
Transport	HTTPS (TLS)
Content-Type	application/json
Character Encoding	UTF-8
Success Code	200 OK unless otherwise noted

API Categories

Core APIs (73 endpoints)

User authentication, profiles, brochures, connections, contacts, teams, identifiers, addresses, dependents, assessments, and more.

View Core APIs

Event APIs (11 endpoints)

Event discovery, invitations, attendance management, brochure access, QR codes, metadata, and agendas.

View Event APIs

RefData APIs (39 endpoints)

Reference data including countries, states, postcodes, professions, specialties, conditions, medications, timezones, and system metadata.

View RefData APIs

Smart Library APIs (22 endpoints)

Smart Library content management — sessions, uploads, entries, URLs, tags, and AI ingestion.

View Smart Library APIs

Samples APIs (8 endpoints)

Sample product management — product listings, order submissions, stock tracking, and reconciliation.

View Samples APIs

SmartForm APIs (4 endpoints)

Form and survey submissions, status tracking, and response management.

View SmartForm APIs

Smart Directory APIs (15 endpoints)

Directory metadata, consent management, contact profiles, photos, and address operations.

View Smart Directory APIs

Membership APIs (9 endpoints)

Membership details CRUD, API key access, team assignment, and member management.

View Membership APIs

Notification APIs (11 endpoints)

Push notifications, email alerts, scheduled notifications, and delivery tracking.

View Notification APIs

User Preferences (12 endpoints)

App-level and asset-level user preferences — create, update, and delete operations.

View User Preference APIs

Admin APIs (2 endpoints)

Admin-only endpoints for retrieving user details via API key.

View Admin APIs

Single Sign On (6 endpoints)

SSO authentication flows — user scheme detection, Ping Federate integration, and token management.

View SSO APIs

Discoverable Entity APIs (4 endpoints)

Entity discovery, recommendations, and connection requests.

View Discoverable Entity APIs

Internal APIs (2 endpoints)

Internal-only operations for hard deletion of users and events.

View Internal APIs