This article is a technical reference for developers working with the Sydnee API.
If you’re just looking for a high-level overview, see what the Sydnee API lets you do.
Quick Links:
Full API Documentation
Full schemas, examples, pagination details, error models and more can be found in these references:
Note: The OpenAPI spec is generated automatically from the production server. If there is ever a discrepancy between the Postman docs and the OpenAPI spec, the OpenAPI spec should be considered the source of truth.
Observability & limits per API key
Per-key insights:
Created: When the key was generated
Last used: Most recent successful request
Usage (30 days): Count of requests per key over the last 30 days
Global limit: 60 requests per minute. If you exceed this, you’ll receive 429 Too Many Requests with rate-limit headers indicating when to retry.
Common errors & how to fix them
401 Unauthorized
Missing/invalid key or wrong header format.
Check Authorization: Bearer <YOUR_API_KEY>.
Confirm the key wasn’t revoked.
403 Action not allowed
Attempting operations not permitted (e.g., removing the Company Owner, sending a request to a teamUser, or using an empty request template).
404 Not Found
The account or user ID doesn’t exist or isn’t accessible to your company.
429 Too Many Requests
You hit the 60 req/min limit. Use Retry-After or back off and retry.
Consider short-term caching and batching reads.
500 Internal Server Error
Temporary issue or unexpected input. Try again; if persistent, contact support with the error id from the response. We are tracking the ID's in our error reporting so the returned error from the API is extremely helpful. We are actively monitoring all returned 500 codes.
Security & best practices
Rotate keys regularly and after staff changes.
Use one key per integration so you can revoke without broad impact.
Limit exposure: Store keys in your secrets manager (not in code, repos, or client-side apps).
Monitor usage in Settings → API to spot anomalies.