API quickstart and authentication

Sydnee's public API uses bearer API keys. It does not use OAuth.

The production base URL is https://public-api.sydnee.app. Version 1 routes start with /v1.

Who can create an API key?

A workspace owner or admin can create and delete keys in Company Settings. API keys are included with paid plans.

The initial free trial without a payment method does not include API access. Select a plan and add a payment method to unlock it. API access continues during any trial period shown at checkout and while the selected plan remains active. It also continues during Sydnee's current grace period for a past-due payment.

Create a key

Open Company Settings.
Select API Keys.
Select Create new API key.
Add a label, such as Zapier or Billing sync.
Copy the key to a password manager or server secret store.

You can keep up to five keys. You can reveal and copy a key again later. The page also shows when each key was made, when it was last used, and its request count for the last seven days.

Protect the key

Treat a key like a password. It gives API access to the workspace, not just one account.

Keep it in a server-side secret store.
Do not put it in browser code, a public repository, a screenshot, or any support or chat message.
Use a different key for each integration. This lets you stop one connection without breaking the rest.
Do not put a real key in sample code or API logs.

Send your first request

Add the key to the Authorization header after the word Bearer.

curl "https://public-api.sydnee.app/v1/accounts" \
  --header "Authorization: Bearer YOUR_API_KEY"

Do not send the key as a query string or JSON field.

A successful request returns JSON. A failed request returns an error object. Learn about IDs, pages, and errors.

Revoke a key

Delete a key at once if it was shared, exposed, or is no longer needed.

Open Company Settings → API Keys.
Find the key by its label or last four characters.
Select Delete.
Confirm Delete API Key.
Create a new key and update only the integrations that should keep working.

Deletion cannot be undone. API calls and Zapier connections that use the deleted key will fail.

Why is API access unavailable during my trial?

The initial free trial cannot create or use an API key. If checkout includes a trial period after you select a plan and add a payment method, that trial can use the API. Use the API paywall to choose a paid plan and add a payment method.