How do I authenticate with the API?

All requests require a Bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY. You can generate an API key from your Sydnee account settings.

What is the rate limit?

The API has separate rate limits for read and write operations: 30 reads per minute and 30 writes per minute. If you exceed the limit, you'll receive a 429 response with a Retry-After header indicating when you can retry.

How does pagination work?

List endpoints use cursor-based pagination. Each response includes a nextCursor value. Pass it as the cursor query parameter to retrieve the next page. When nextCursor is null or absent, you've reached the last page.

Is there an OpenAPI spec I can use to generate a client?

Yes. The full OpenAPI 3.1 spec is available at https://public-api.sydnee.app/openapi.json and is generated automatically from the production server.

Does the API follow versioning?

The API is versioned at /v1/. Adding new optional fields to responses is not considered a breaking change. Removing or renaming fields is a breaking change and will be communicated in advance.

Developer API

Build on top of Sydnee

A REST API for automating client portals at scale. Create accounts, manage users, send requests, and browse files — all from your own tools.

View Docs

bash

# 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

What You Can Build

Automate the repetitive work of provisioning, onboarding, and collecting from clients.

Create or Archive Accounts

Provision new client portals from your CRM on signup. Archive them automatically when an engagement ends.

Provision portals from your CRM on signup
Sync a list of accounts for reporting
Deactivate former clients automatically

Manage Access to an Account

Keep client and team access in sync with your HRIS, CRM, or onboarding tool.

Automatically invite new clients during onboarding
Keep access in sync with your HRIS or CRM
Remove access when a client offboards

Add Task Templates to Accounts

Standardize onboarding across clients by applying a task template the moment a new account is created.

Apply a 'New Client Kickoff' template on account creation
Keep onboarding consistent across every engagement

Browse Files, Versions & Comments

Retrieve file libraries, version history, and comment threads for review and reporting workflows.

Browse folders and subfolders in an account
Retrieve version history and comment threads
Generate signed download links

Send Onboarding Requests from Templates

Automate client intake by sending requests directly from your CRM or campaign management tool.

Request assets, credentials, or form inputs
Trigger intake at the start of every engagement
Automate intake from your CRM

Bearer TokenAuthentication

30 + 30Reads & Writes / min

Cursor-basedPagination

OpenAPI 3.1Spec Format

Endpoints

API Reference Overview

Five resource groups covering accounts, users, task templates, onboarding requests, and files. More coming soon!

Accounts

Create, list, get, and archive client portal accounts.

POST/v1/accounts
GET/v1/accounts
GET/v1/accounts/:id
DELETE/v1/accounts/:id

Account Users

View, add, and remove portal users from an account.

GET/v1/accounts/:id/users
POST/v1/accounts/:id/users
DELETE/v1/accounts/:id/user/:userId

Task Templates

List your task templates and apply them to any account.

GET/v1/task-templates
POST/v1/accounts/:id/task-templates/:templateId

Requests

List your request templates and send them to any portal user.

GET/v1/request-templates
POST/v1/accounts/:id/user/:userId/requests/:templateId

Files

Browse folders, retrieve file metadata, version history, comments, and download URLs.

GET/v1/accounts/:id/files
GET/v1/accounts/:id/folders/:folderId/files
GET/v1/accounts/:id/files/:fileId
GET/v1/accounts/:id/files/:fileId/download
GET/v1/accounts/:id/files/:fileId/versions
GET/v1/accounts/:id/files/:fileId/comments

Documentation

Full API Documentation

Full schemas, request examples, error models, and pagination details.

OpenAPI 3.1 Spec

Machine-readable spec generated from the production server. Use it to generate clients, validate requests, or explore the API in any OpenAPI-compatible tool.

View spec →

Postman Documentation

Interactive request examples for every endpoint. Browse response shapes, try requests in Postman, and copy curl commands directly.

Open in Postman →

If there is ever a discrepancy between the Postman docs and the OpenAPI spec, the OpenAPI spec is the source of truth.

No-code option

Prefer not to code? Use Zapier.

With Zapier, you get the same building blocks as the REST API — without writing a line of code. Connect Sydnee to thousands of apps and automate client portal workflows in minutes.

You'll need a Sydnee API key to connect. Generate one under Settings → Company Settings → API.

View Sydnee on Zapier →

FAQ

Common Questions

Which Sydnee plans include API access?: API access is available on all paid Sydnee plans.
How do I authenticate with the API?: All requests require a Bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY. You can generate an API key from your Sydnee account settings.
What is the rate limit?: The API has separate rate limits for read and write operations: 30 reads per minute and 30 writes per minute. If you exceed the limit, you'll receive a 429 response with a Retry-After header indicating when you can retry.
How does pagination work?: List endpoints use cursor-based pagination. Each response includes a nextCursor value. Pass it as the cursor query parameter to retrieve the next page. When nextCursor is null or absent, you've reached the last page.
Is there an OpenAPI spec I can use to generate a client?: Yes. The full OpenAPI 3.1 spec is available at https://public-api.sydnee.app/openapi.json and is generated automatically from the production server.
Does the API follow versioning?: The API is versioned at /v1/. Adding new optional fields to responses is not considered a breaking change. Removing or renaming fields is a breaking change and will be communicated in advance.
Is there a no-code option?: Yes. Sydnee has a native Zapier integration at zapier.com/apps/sydnee/integrations. You'll need a Sydnee API key to connect — generate one under Settings → Company Settings → API. The REST API is for custom integrations where you need more control; Zapier is the better fit for no-code automations.

API access is available on all paid Sydnee plans.

Need to know which plan is right for you? Compare plans →

Try Sydnee Client Portals Today

Start free trial

No credit card required

Client & team live chat

Built in task manager

Showcase services in your portal

Easy client onboarding & info requests

Secure file storage & sharing

Embed Calendly, Figma, Loom, Google Looker & more

Custom domain & full white labeling

Unlimited client seats

Start Free Trial

No credit card required

Explore More Features

Discover other powerful tools included in Sydnee Client Portals

Tasks & Reminders

Collaborate with clients on tasks with unlimited seats

Learn more →

Live Chat

Real-time messaging built into your client portal

Learn more →

Client Requests

Collect files and information with custom forms

Learn more →

Service Showcase

Display services and enable passive upsells

Learn more →