Unlock the potential of connecting your own apps and scripts to SyncSketch
You want to integrate SyncSketch more closely into your existing pipeline?
We offer a fully-featured API through which all commands on SyncSketch can be called programmatically.
If you have more questions, don't hesitate to ask us at email@example.com.
Please find the complete API documentation on our dedicated site here:
Download the Python API here:
Individual API key or Script User?
Individual users can have API credentials that are useful for tools that need access to properties unique to that individual. But in most cases, best practice is to use Script Users.
API Script Users are virtual users that only have access to the Project through the API. Using script users allows scripts and integrations to keep working regardless of personnel changes, individual API key rotations etc.. The Workspace administration allows for as many script users as necessary so that you can create one for each script or integration, so that rotating the API key for security only affects a specific application instead of unexpectedly breaking others. See the API Script Users documentation for further details.
Getting your individual credentials
To start using this API, you will need your API Username and API Key, which you can find near the bottom of:
User Profile>Settings>Developer Info
The moment you generate an API key is the last time you will ever see it in SyncSketch. Be sure to click the Copy button (clipboard icon) and store it in a secure location.
Tip: Your API key can change from time to time, so don't hard-code it into anything if you can avoid it. Instead, store it as an environment variable on your development system, pipeline host, container build files, or in your REST API development environment.
The next time you open your User Profile, the API key will not be readable and cannot be copied. There is no way to recover your API key, but you can generate a new one with the Rotate API Key button:
After clicking this button, you will be advised that any script or tool referencing the old API key will need to be updated. (Don't forget environment variables!) Then you will have the opportunity to copy the new API key and store it securely.
The API Key Age field indicates how long it has been since the last key rotation. Best security practice is to rotate your API key annually, quarterly or monthly depending on your organization's information security policy.
I don't have a Developer Info section!
If you do not see a Developer Info section in your User Profile (not your Workspace Settings!), you will need to upgrade to an Enterprise or Education Plus plan. If you are on one of these and you do not see this section, check your role in the Workspace. Members, Viewers and Reviewers cannot generate an API key. Are you an Admin? If yes, contact us at firstname.lastname@example.org.
I've lost my API Key!
See the section above about Key Rotation.
I don't want our API credentials to be tied to an individual user.
That's a great idea! In that case, we recommend creating a script user instead of generating API keys for an individual user.