Skip to content
Symbiant System Black Logo
  • Home
  • Knowledge Base
  • Symbiant Website
  • Symbiant Changelog
  • Submit a Ticket
  • My Support Tickets
  • Home
  • Knowledge Base
  • Symbiant Website
  • Symbiant Changelog
  • Submit a Ticket
  • My Support Tickets
Popular Keywords importuserdivisionsamlimport risk

Admin Basics

  • Sharing Dashboard Layouts with Other Users
  • Setup Mode/Admin Menu
  • Creating/Adding Users
  • Transferring Ownership from One User to Another (Assuming)
  • Making a User Active/Inactive
  • Delete a User
  • Changing a Record Reference
  • Managing Drop-Downs, Multi-Selects, and Multi-Levels
  • Resetting a User’s Password
  • Checking System Attachment Storage
  • Database History & Restoring Historical Records
  • Restoring a Deleted Record (Archived)
  • Audit Trails
  • Email Log Viewer
  • System Menu Layout & Options

System Translations

  • Adding a Translation Pack
  • Editing a Translation Pack
  • Mass Editing a Newly Created Translation Pack
  • Assigning a Translation Pack to a User
  • Exporting a Translation Pack
  • Importing a Translation Pack
  • Adding a Default Translation Pack
  • Creating a Locale Specific View (Translated View)
  • Editing a Locale Specific View (Translated View)

Importing Data

  • Preparing Data for Import (Default)
  • Imports with Hierarchical Data
  • Importing Data (Generic)
  • Preparing Data for Import (Risks)
  • Importing Data (Risk Register Specific)
  • Preparing Data for Import (Users)
  • Importing Users
  • Importing Divisions
  • Importing Errors & Issues

User FAQ

  • Login Issues

Automated Emails (Task Based)

  • How Automated Emails Work (Triggers and Schedules)
  • Activating and Deactivating an Automated Email (Trigger) and (Scheduler)
  • Creating an Automated Email – When a Record is Created (Trigger)
  • Creating an Automated Email – When a Record is Updated (Trigger)
  • Creating an Automated Email – When a Record is Deleted (Trigger)
  • How to Receive Module Specific Emails as System Admin (Trigger) and (Scheduler)
  • Editing an Automated Email – Sending to a Different Module Role (E.g. Risk Manager) (Trigger)
  • Editing an Automated Email – Sending to a Record User (Trigger)

Automated Email Reminders (Time Based)

  • How Automated Emails Work (Triggers and Schedules)
  • Activating and Deactivating an Automated Email (Trigger) and (Scheduler)
  • Creating an Automated Email Reminder – When a Record is Due (Scheduler)
  • Creating an Automated Email Reminder – When a Record is Overdue (Scheduler)
  • Setting up Recurring Schedules
  • How to Receive Module Specific Emails as System Admin (Trigger) and (Scheduler)
  • Editing an Automated Email Reminder – Sending to a Different Module Role (E.g. Risk Manager) (Scheduler)
  • Editing an Automated Email Reminder – Sending to a Record User (Scheduler)

System Views

  • Editing a Dashboard Chart
  • Sharing Dashboard Layouts with Other Users
  • System Views (Quick Explainer)
  • Creating Your Own Custom Views
  • View Editor Tool Overview
  • Editing a View
  • How to Hide/Unhide Fields
  • Loading/Saving a Particular User’s View
  • What are Widgets?
  • Adding, Removing and Editing a Grid Column
  • Adding Help Tips & Placeholder text
  • Modifying a User Field to Limit or Allow Specific Users
  • Modifying a Currency Field to Set Default

Exporting Data

  • Exporting Dashboard Data
  • Exporting Divisions
  • Exporting Users
  • Generating the System User Details Report

System Errors & Issues

  • Resolving System Issues
  • System Error Messages
  • Login Issues

System Setup

  • Creating/Adding Users
  • Making a User Active/Inactive
  • Delete a User
  • Transferring Ownership from One User to Another (Assuming)
  • Login Issues

Reporting Suite Tutorial

  • Creating a Word Report (Basic Data Output)
  • Creating an Excel Report (Basic Data Output)
  • Creating a PowerPoint Report (Basic Data Output)
  • Creating an Excel Tabular Report (Perfect for CSV)
  • Creating an Excel Audit Report (Audit Log Of Changes)
  • Adding a new column to an Excel Report
  • Removing a column in an Excel Report
  • Creating an Advanced Word Report (Adding Functions)
  • Advanced Report Coding (Using Owners, Divisions & Assignees in a Report)
  • Advanced Report Syntax
  • Advanced Filtering on Reports (Filtering Via Code)
  • Reporting Permissions

Advanced System Functionality

  • Symbiant API

Document Management (System Setup)

  • Setting Up Document Types
  • Setting Up Document Statuses
  • Document Storage Limits and File Sizes

Admin FAQ

  • Symbiant System Best Practices
  • Login Issues
  • Creating/Adding Users
  • Delete a User
  • Moving Divisions (Restructuring)
  • How to Receive Module Specific Emails as System Admin (Trigger) and (Scheduler)

System FAQ

  • Resolving System Issues
  • Creating/Adding Users
  • Login Issues

Account FAQ

  • Creating/Adding Users
  • Login Issues
View Categories
  • Home
  • Knowledge Base
  • Admin Information
  • Advanced System Functionality
  • Symbiant API

Symbiant API

0:00 / 5:11
  • View as Markdown Open this page as plain Markdown (opens in a new tab)
  • Open in ChatGPT Ask questions about this page (opens in a new tab)
  • Open in Claude Ask questions about this page (opens in a new tab)
  • Open in Google AI Studio Ask questions about this page (Google account required) (opens in a new tab)
AI Doc Summarizer Doc Summary
AI Doc Summarizer Thinking Thinking

Symbiant has a REST API so your own systems can read and write Symbiant data. This article explains how to get access, authenticate and make requests. The examples use the Incidents module, but every module works the same way.

Note: Before you can use the API, Symbiant must allow your server’s IP address to connect. Raise a support ticket to arrange this.

What You Need #

  • A Symbiant user account with an API-enabled role. If you don’t have one, raise a support ticket.
  • An EDN (Extensible Data Notation) parser for your language, for example edn-java, jsedn, edn-ruby or edn_format for Python.
  • A Transit encoder and decoder, for example transit-java, transit-js, transit-ruby or transit-python.

Warning: These libraries are written by third parties. Symbiant can’t guarantee them, and you use them at your own risk.

How Access Works #

Every API request is made as a specific user with an API-enabled role. The API applies the same permissions as the Symbiant app: the user can only read and change what they could in the app, including only records in their divisions. Make sure the user has the roles and divisions the job needs.

Getting an API Token #

  1. Sign in to Symbiant as the API-enabled user.
  2. Click the three dots (⋮) at the top right, then API token. If you don’t see it, the user doesn’t have an API-enabled role.

API token in the menu

  1. A text file downloads. It contains everything you need:

The parts of the API token file

ItemWhat it’s for
:id_tokenThe token you send with every request
:expires_inHow many seconds the token lasts (for example 900, which is 15 minutes)
:refresh_tokenUsed to get a new :id_token without signing in again
:api_urlThe address to send requests to. In the examples below it is written {{:api_url}}
:client_id, :refresh_urlUsed when refreshing the token

Critical: Keep the token file secret. Anyone with it can act as that user until it expires.

Making Requests #

The API follows the usual REST pattern. The address starts with /read/ for reading and /write/ for changes:

ActionMethodAddress
Read recordsGET{{:api_url}}/read/modules/{module}
Read one recordGET{{:api_url}}/read/modules/{module}/{reference}
Create a recordPOST{{:api_url}}/write/modules/{module}
Update a recordPATCH{{:api_url}}/write/modules/{module}/{reference}
Delete a recordDELETE{{:api_url}}/write/modules/{module}/{reference}

Tip: :api_url already ends with a slash, so don’t add a second one.

Every request needs these headers:

The headers every request needs

Request and response bodies are EDN, encoded with Transit (JSON). Attribute names are namespaced keywords, for example :incident/reference (written "~:incident/reference" in Transit).

Reading a Record (GET) #

This reads incident 9:

A GET request for one incident

The response holds the record’s attributes and values. Drop-down and linked values come back with their text and IDs:

Part of the response

GET Filters #

Add filters to the address to narrow the results:

FilterMeaningValue
ppullA comma-separated list of the attributes to return
eequal toAttribute and value separated by a comma; use a semi-colon to go into nested attributes
nnot equal toAs above
lless thanAs above
ggreater thanAs above
leless than or equal toAs above
gegreater than or equal toAs above
ccontainsAs above. Text values only, URL encoded, and case sensitive
xexistsMust have the listed attributes
mmissingMust not have the listed attributes

For example, ?p=incident/reference,generic/summary returns only the reference and summary of every incident:

A GET with the pull filter

Finding Resources and Attributes (help) #

Put /help in front of any address to see its structure instead of its data:

  • {{:api_url}}/help lists every resource and attribute.
  • {{:api_url}}/help/read/modules/{module}/{reference} shows what a GET returns.
  • {{:api_url}}/help/write/modules/{module} shows what a POST needs. Add a reference to see what a PATCH accepts.

The results show each attribute, whether it’s required, whether it holds a list, and which is the primary key.

The help output for creating an incident

Module names match the app. When you open a module, the address bar shows its name, for example app.symbiant.cloud/modules/incidents or /modules/register-risks. Use the same name in the API.

Creating a Record (POST) #

The primary key (for example :incident/reference) is always required, along with any attributes the help output marks as required (for example :generic/summary). Linked values such as divisions are given by ID.

A POST creating an incident

Updating a Record (PATCH) #

Always include the primary key, then only the attributes you’re changing. Don’t send unchanged attributes, because they would add noise to the audit trail. This example adds a division to incident 101:

A PATCH adding a division

Removing Values #

To remove a value, put it under :tx/retract in a PATCH:

Removing a division with tx/retract

Deleting a Record (DELETE) #

Critical: A DELETE request removes the record straight away.

A DELETE request

Refreshing the Token #

Before the :id_token expires, use the refresh token to get a new one. Send a POST to the :refresh_url from your token file:

Refreshing the token

The response contains a new id_token and refresh_token. It doesn’t include the URLs or client ID, so keep using those from the original token file.

Testing the Connection with Postman #

You can check you can connect with a tool such as Postman. Postman can’t decode Transit, so use it only to test the connection. (The Postman screenshots are from an earlier version of this article.)

  1. Create a GET request.

A GET request in Postman

  1. Open Headers, then add Origin (your Symbiant app address, for example https://app.symbiant.cloud) and Content-Type (application/transit+json).

The Origin header

The Content-Type header

  1. Open Authorization, set Auth Type to Bearer Token, and paste in only the :id_token value (not the whole file, and not the refresh token).

Choosing Bearer Token

  1. Enter an address, for example {{:api_url}}/read/modules/incidents/1, and click Send. A 200 OK status with data in the body means the connection works.

A successful response

Did this help?

Share This Article :

  • Facebook
  • X
  • LinkedIn
Require Additional Information? Please Contact Support

How can we help?

Updated on 30 October 2026
Table of Contents
  • What You Need
  • How Access Works
  • Getting an API Token
  • Making Requests
  • Reading a Record (GET)
  • GET Filters
  • Finding Resources and Attributes (help)
  • Creating a Record (POST)
  • Updating a Record (PATCH)
  • Removing Values
  • Deleting a Record (DELETE)
  • Refreshing the Token
  • Testing the Connection with Postman
Symbiant System White Logo

20-22 Wenlock Road

London

N1 7GU

Linkedin
Telephone Numbers
  • UK - 0113 5263 755
  • Support - 0204 5514 735 option 2
  • USA - 347 991 7130
Information
  • Home
  • Knowledge Base
  • Symbiant Website
  • Submit A Ticket
  • Change Requests
  • Support Staff Login

Copyright © 2025 Symbiant All Rights Reserved - Risk, Audit and Compliance Management Software

We use cookies on our website to give you the most relevant experience by remembering your preferences and repeat visits. By clicking “Accept All”, you consent to the use of ALL the cookies. However, you may visit "Cookie Settings" to provide a controlled consent.
Cookie SettingsAccept All
Manage consent

Privacy Overview

This website uses cookies to improve your experience while you navigate through the website. Out of these, the cookies that are categorized as necessary are stored on your browser as they are essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may affect your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. These cookies ensure basic functionalities and security features of the website, anonymously.
CookieDurationDescription
cookielawinfo-checkbox-analytics11 monthsThis cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Analytics".
cookielawinfo-checkbox-functional11 monthsThe cookie is set by GDPR cookie consent to record the user consent for the cookies in the category "Functional".
cookielawinfo-checkbox-necessary11 monthsThis cookie is set by GDPR Cookie Consent plugin. The cookies is used to store the user consent for the cookies in the category "Necessary".
cookielawinfo-checkbox-others11 monthsThis cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Other.
cookielawinfo-checkbox-performance11 monthsThis cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Performance".
viewed_cookie_policy11 monthsThe cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.
Analytics
Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics the number of visitors, bounce rate, traffic source, etc.
SAVE & ACCEPT
Loading...

Insert/edit link

Enter the destination URL

Or link to existing content

    No search term specified. Showing recent items. Search or use up and down arrow keys to select an item.