Documentation

Developer Documentation

Guides, references, and concepts for building on the Simply360 platform.

Search the documentation

Getting Started3 articles

Simply360 Developer Platform Overview

What you can build with the Simply360 API, SDKs, CLI, and MCP server, plus where to go next as a developer.

Getting Started with the Simply360 API

Set up your environment, install the TypeScript SDK, create an API key, and make your first Simply360 API call.

Environments

Choose the production, staging, or development endpoint for your Simply360-powered app and understand how non-production access is enabled.

Authentication & Security1 article

Authentication

Three ways to authenticate to the Simply360 API: long-lived API keys, short-lived session tokens, and Cognito JWT for first-party clients.

API Concepts3 articles

Pagination, Sorting & Field Selection

How to paginate through large result sets, control sort order, and request only the fields you need.

Rate Limiting

Per-tier rate limits applied to each API credential, response headers for monitoring, and recommended retry strategies.

Error Handling

Standard error envelope, error codes, HTTP status codes, and how to handle errors with the TypeScript SDK.

Tools & SDKs3 articles

TypeScript SDK

The official @simply360/sdk package — installation, configuration, the resource clients it exposes, and code examples for common operations.

Command-Line Interface (CLI)

The official Simply360 CLI: install with npm, authenticate with set-key, and manage collections, records, API keys, webhooks, and more from your terminal.

MCP Server

Connect Claude, ChatGPT, Claude Code, and other MCP-compatible AI assistants to Simply360 through the hosted remote MCP endpoint.

Embedding1 article

Embedding DataViews, Wizards & the Conversation Widget

Add Simply360 DataViews, Data Wizards, and the AI Conversation Widget to any website with a single bootstrap script and data-* attributes.

API Reference28 articles

API Reference: Data Collections

Manage Data Collections via the API: list collections, retrieve full schemas, and inspect field definitions.

API Reference: Data Records

List, get, create, update, replace, delete, search, and batch-process Data Records via the Simply360 API.

API Reference: Data Views

List Data Views, retrieve their configuration, and page through the records they expose.

API Reference: Data Wizards

List Data Wizards, inspect their schema, and execute them programmatically.

API Reference: Files

Upload trusted files, retrieve metadata, generate presigned download URLs, and access image variants.

API Reference: Messages

List Message Studio aggregates, inspect delivery status, and read safe cross-channel constituent communication history.

API Reference: Conversations

Threaded conversations between team members and constituents over chat, email, and SMS — list, get, send replies.

API Reference: Tags (SimplyTags)

Manage standalone URL and Link Page Actions, retention-aware analytics, CSV, custom domains, and signed webhooks; powered record/Wizard fields require an eligible Simply360 contract.

API Reference: Webhooks

Subscribe to event notifications via webhook subscriptions, verify signatures, and inspect delivery logs.

API Reference: Automations

Create, configure, and inspect automations and review their execution history.

API Reference: Reports

List Reports, retrieve their configuration, and trigger refreshes.

API Reference: Users

Look up the current authenticated user, list team members, and fetch a specific user's profile.

API Reference: Audit Log

Query the audit log of data changes by record, collection, user, action type, or date range.

API Reference: API Keys

Manage the full API key lifecycle: list, create, update, rotate, and revoke keys for your team.

API Reference: Session Tokens

Create and manage short-lived, scoped session tokens (s360_sess_*) for browsers, AI agents, and partner access.

API Reference: Constituent Authentication

Verify the identity of a DataRecord 'person' (a constituent) so client apps can access their own data securely. Initiate via email or SMS link/code, verify, refresh, and read the profile.

API Reference: Content Templates

Reusable content templates that power outgoing messages, canned responses, and document generation. List, retrieve, create, copy, and assign document templates to collections.

API Reference: App Store (Purchases & Entitlements)

Verify Apple App Store and Google Play purchases, list a constituent's entitlements, and issue secure download URLs for purchased content.

API Reference: Message Templates

List, create, update, and delete message templates — the reusable email and SMS bodies that the Messages API renders against recipient records.

Webhook Event Payloads

The structure of every webhook event Simply360 delivers: the common envelope plus per-event-type payload fields.

API Reference: Websites & Pages

Manage team websites end to end: sites, pages and designs, campaign chrome, publishing and readiness checks, imports, backups, templates, layouts, review comments, and access areas.

API Reference: Simply Spaces Bookings

Check availability, browse bookable slots, quote pricing, and submit bookings through public Simply Spaces booking links, plus the source-connection booking channel APIs.

API Reference: Background Tasks

Track long-running operations: list and inspect background tasks, acknowledge errors, read per-record task history, and download record output files.

Read and manage the signed-in user's notification feed: list and filter notifications, poll unread counts, mark items read, manage per-device notification preferences, and register mobile push tokens.

API Reference: Signing Requests

Create and manage e-signature requests anchored to a data record: configure signers and review fields, track the signing lifecycle, reissue signer links, and void in-flight requests.

API Reference: Team Agent (Ask Simply)

Drive Ask Simply, the in-app AI agent: manage sessions and messages, approve or reject agent proposals, escalate to human support, and administer knowledge sources.

Data-Scoped Feature Permissions

Understand Feature Permissions that are enabled for a team but granted through Collection data permissions.

API Reference: Solutions

List, preview, apply, inspect, update, and detach first-party Collection Solutions through seven public-ID-only contracts.

Release Notes1 article

API Changelog

Versioning policy and the change log for the Simply360 public API.