APIs

You can use Synap's APIs and Webhooks to automate your workflows, export your data and more.

Pro customers get access to Synap's Org API endpoints at https://docs.synap.ac/ - this includes endpoints for our most commonly requested use cases.

Business and Enterprise customers get access to our V3 API which is extremely comprehensive, and covers 100% of Synap functionality. For more details, refer to our V3 API Reference.

We have a range of API endpoints and Webhooks you can use to extend the functionality of Synap, or respond to key events that occur on your platform.

Please visit the corresponding API docs for your plan, for the Org API (Pro) you'll need to request credentials which you can do from the chat on platform at any time.

Attribute types in the API

Synap supports a range of custom attributes across key areas on the platform head over to Settings>Data Management>Attributes to create and manage attributes.

Attributes are let you create additional fields which can be included and updated in API requests, helpful for storing things like: Re-certification dates, country, latest / average score. These custom attribute values will be included in relevant API payloads.

Learn more about attributes in our docs below

Attributes

Attribute type	Format required
Checkbox	TRUE or FALSE
Long answer	string
Short answer	string
Multiple choice	string
Checkboxes	string[]eg 'mycheckbox: ["maths","english","science"]
Number	Any numerical value
Date	DD/MM/YYYY
Link	Choose whether to display as text or as a button. The link can be typed as an absolute URL (opens in new tab), or a root-relative URL (open in the same tab)
File	Only .pdf files are accepted on platform or through the API. Files uploaded through the API are limited to 5mb each, or 10mb per request.

Attribute manage on platform (Business / Enterprise options)

Webhooks