> For the complete documentation index, see [llms.txt](https://synap.ac/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://synap.ac/docs/integrations/apis.md).

# APIs

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

{% hint style="info" %}
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.&#x20;

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](/docs/api/getting-started.md).
{% endhint %}

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.&#x20;

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.&#x20;

### Attribute types in the API&#x20;

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.&#x20;

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.&#x20;

&#x20;Learn more about attributes in our docs below

{% content-ref url="/pages/vJsglaSbW0ujvIgs8DX4" %}
[Attributes](/docs/portal-settings/data-management/attributes.md)
{% endcontent-ref %}

| 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.                 |

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FGvJE7415Nt9FIEF5PHe9%2FScreenshot%202025-05-23%20at%2009.21.36.png?alt=media&amp;token=a3b6bd41-89df-4681-af87-4b7f717ceb6d" alt=""><figcaption><p>Attribute manage on platform (Business / Enterprise options)</p></figcaption></figure>

{% content-ref url="/pages/lLtdnh347vvEx2haHEMJ" %}
[Webhooks](/docs/integrations/webhooks.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://synap.ac/docs/integrations/apis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.