Sydnee API reference
Use the live API explorer or download the generated OpenAPI 3.1 contract.
The OpenAPI file is the machine-readable contract for every public v1 route and field.
The production server in the contract is https://public-api.sydnee.app.
What does the reference cover?
The current contract covers these groups:
- Accounts
- Account Users
- Task Templates
- Tasks, boards, sections, tags, comments, reminders, and task attachment uploads
- Requests and request templates
- Files, versions, comments, download URLs, account file uploads, and new-version uploads
It shows:
- the method and path;
- the fields you send;
- the data you get back;
- examples and errors; and
- bearer-key access.
The OpenAPI file does not define the Zapier builder. A Zap is an automated workflow in Zapier; a trigger starts it, and an action is a step it takes. Use Connect Sydnee to Zapier for the current Zapier options.
Find an endpoint
- Open the interactive reference.
- Choose a resource group.
- Choose the method and path.
- Read every required path, query, and body field.
- Check the response and error schemas.
- Test with non-sensitive data.
Task and file routes are under an account. Task routes also name the account task board.
Use the JSON with a tool
Give your code generator, API client, or validation tool this URL:
https://public-api.sydnee.app/openapi.jsonDownload a fresh file before you make code from it. New v1 routes and fields can change the file.
Do not copy a key into a public tool or shared prompt. Import the file with no key. Add the key later from your secret store.
Which fields does an endpoint accept?
The request schema under that method is the answer. Do not copy fields from a different method or from the Sydnee app's private requests.
If a guide and the live file do not match, use the live file for the request shape. Then report the mismatch to Sydnee.