Developer API
A REST API for automating client portals at scale. Create accounts, manage users, send requests, browse files, and now manage tasks — all from your own tools.
# Create a new client portal account
curl -X POST https://public-api.sydnee.app/v1/accounts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"accountName": "Acme Corporation"}'
# 201 Created
{
"id": "c5588dd",
"name": "Acme Corporation",
"slug": "acme-corporation",
"createdAt": "2026-05-14T16:00:00.000Z"
}Use Cases
Automate the repetitive work of provisioning, onboarding, and collecting from clients.
Provision new client portals from your CRM on signup. Archive them automatically when an engagement ends.
Keep client and team access in sync with your HRIS, CRM, or onboarding tool.
Standardize onboarding across clients by applying a task template the moment a new account is created.
Retrieve file libraries, version history, and comment threads for review and reporting workflows.
Automate client intake by sending requests directly from your CRM or campaign management tool.
Automate task creation and full lifecycle management across client accounts — set due dates, assignees, priorities, and update status programmatically.
Endpoints
Eight resource groups covering accounts, users, templates, requests, files, and full task management.
Provision new client portal accounts, list and retrieve them by ID, and archive accounts when an engagement ends. The starting point for every integration.
List all users on an account, add new portal users by email, and remove access when a client offboards. Keep permissions in sync with your HRIS or CRM automatically.
List the task templates you've built in Sydnee and apply any of them to a client account in a single API call. Standardize onboarding without manual setup.
List your request templates and send them directly to any portal user. Trigger client intake — asset uploads, form submissions, credentials — from your CRM or automation tool.
Browse root-level and folder-scoped file libraries, retrieve file metadata, fetch version history, read comment threads, and generate signed download URLs — all read-only.
List the task boards on any account and retrieve their sections. Use these as the entry point for reading and writing tasks within a specific board.
Create and list tasks, retrieve full task detail, and update any field independently — title, description, status, assignee, due date, priority, and visibility. Move tasks between sections, manage collaborators, post and read comments, track the full activity log, set or delete reminders, and download task attachments.
Always-in-sync OpenAPI 3.1 spec generated directly from production — ready for client generation and LLM tool-calling. Consistent typed error envelopes on every endpoint, cursor pagination that never drifts, and a versioning guarantee: no breaking changes without advance notice.
Documentation
Full schemas, live examples, and a no-code path — everything you need from day one.
Machine-readable spec generated from the production server. Use it to generate clients, validate requests, or load into any OpenAPI-compatible tool.
View spec →
Try any endpoint directly in the browser. Full request and response schemas, live examples, and curl snippets — no setup needed.
Open API docs →
No-code option
Connect Sydnee to thousands of apps and automate client portal workflows without writing a line of code. Generate an API key under Settings → Company Settings → API to connect.
View Sydnee on Zapier →If there is ever a discrepancy between the interactive docs and the OpenAPI spec, the OpenAPI spec is the source of truth.
FAQ
API access is available on all paid Sydnee plans.
Need to know which plan is right for you? Compare plans →
Discover other powerful tools included in Sydnee Client Portals