Developer API
Build on top of Sydnee
A REST API for automating client portals at scale. Create accounts, manage portal users, send requests, browse files, and manage tasks — all from your own tools.
API and Zapier access unlock after you select a paid plan and add payment details. Checkout will confirm when billing begins.
# 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"
}Documentation
Ready to integrate
Full schemas, live examples, and a no-code path — everything you need to evaluate and build an integration.
OpenAPI 3.1 Spec
Machine-readable contract generated from the API schemas. Use it to generate clients, validate requests, or load into an OpenAPI-compatible tool.
View spec →
Interactive API Docs
Explore request and response schemas, examples, and curl snippets in the browser. Use your Sydnee API key when testing authenticated endpoints.
Open API docs →
No-code option
Prefer not to code? Use Zapier.
Use supported Sydnee actions in Zapier to provision accounts or portal users, send a request from a template, or add a task template to an account. Generate an API key under Company Settings → API Keys to connect.
View Sydnee on Zapier →Check the current OpenAPI specification before shipping an integration against the REST API.
FAQ
Common Questions
- Which Sydnee plans include API access?
- API access is included with every paid Sydnee plan. The initial free trial without a payment method does not include API access. If checkout includes a trial after you select a plan and add payment details, you can use the API during that trial.
- How do I authenticate with the API?
- Authenticated /v1 requests require a Bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY. Workspace owners and admins can create API keys under Company Settings → API Keys.
- Can I manage more than one API key?
- Yes. The current Company Settings interface supports up to five labeled API keys. It also shows each key's creation date, most recent use, and request count for the last seven days, and lets you delete a key when it is no longer needed.
- What is the rate limit?
- The API has separate rate limits for read and write operations: 300 reads per minute and 100 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?
- Supported list endpoints use cursor-based pagination. When a response includes nextCursor, pass that exact value as the cursor query parameter for the next page. Stop when nextCursor is empty or missing. Not every list endpoint uses a cursor, so check the live API reference for the route you are using.
- Is there an OpenAPI spec I can use to generate a client?
- Yes. The current OpenAPI 3.1 contract is available at https://public-api.sydnee.app/openapi.json and is generated from the API schemas.
- Does the API follow versioning?
- Yes. The current public REST API is versioned under /v1/. Build against the current OpenAPI specification so your integration follows the published request and response contract.
- 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 Company Settings → API Keys. The REST API is for custom integrations where you need more control; Zapier is the no-code option for supported workflows.
API access is included with every paid Sydnee plan.
The initial free trial without a payment method does not include API access. Need to know which plan is right for you? Compare plans →
Try Sydnee Client Portals Today
Explore More Features
Discover other powerful tools included in Sydnee Client Portals