API Calls: Apiary Documentation

iFormBuilder API

API Versions
POSTman API Service
Token Resource
Profile Resource
User Resource
User Group Resource
Page Resource
Page Group Resource
Element Resource
Optionlist Resource
Record Resource
Notification Resource
Private Media Resource
Device License Resource

API Versions

v5.1 and lower: Deprecated as of June, 11, 2018. Please read our migration guide from v5.1 to v6.0 here.
v6.0 Original Release July 2015: Documentation
v8.0 Original Release May 2021: Documentation
v8.1 Original Release July 2021: Documentation

For version 6.0:

To make a request, the base URL will look like:

https://[servername].iformbuilder.com/exzact/api/v60/

For servername, you would use the subdomain used to access iFormBuilder. For example, app.iformbuilder.com customers would use app as the servername.

For versions 8.0 and 8.1:

To make a request, the base URL will look something like:

https://[region].iformbuilder.com/exzact/api/v80/[servername]

The region is where your server is located. The table below shows what the subdomain would be for each region.

Region	Subdomain
United States	api
Australia	au-api
United Kingdom	uk-api
HIPAA	hipaa-api
Internal Sandbox	sandbox-api

For servername, you would use the subdomain used to access iFormBuilder. For example, if you want to use the API for app.iformbuilder.com, the URL would look like

https://api.iformbuilder.com/exzact/api/v80/app

POSTman API Service

POSTman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.

You can import the following collections into POSTman by API version to get started quickly and familiar with different API requests. Please make sure to update all parameters which currently show square brackets (ex. [servername]) with relevant values from your database.

API 6.0 Collection - Copy the link and use it to import into POSTman: https://www.getpostman.com/collections/622b65fb2318384167b7
API 8.0 Collection - Download the File Here

Token Resource

Token: Inspect token attributes

API 6.0

API 8.0

API 8.1

Profile Resource

Profile Resource includes the following:

Profile: Retrieve or Update a profile
Company Info: Retrieve or Update company info
Profile Collection: Retrieve a list of profiles
New Profile Collection: Create a new profile

API 6.0

API 8.0

API 8.1

User Resource

User Resource includes the following:

User: Retrieve, Update or Delete a user
User Collection: Retrieve, Update or Delete a list of users
New User Creation: Create new users
Page Assignment: Retrieve, Update or Delete a page (form) assignment with Page/User ID
Page Assignment Collection: Retrieve, Update or Delete a list of page (form) assignments
New Page Assignment Collection: Create new page (form) assignments
Record Assignment: Retrieve or Delete a record assignment
New Record Assignment Collection: Create new record assignments

API 6.0

API 8.0

API 8.1

User Group Resource

User Group Resource includes the following:

User Group: Retrieve, Update or Delete a user group
User Group Collection: Retrieve a list of user groups
New User Group Creation: Create new user groups
User Assignment: Retrieve or Delete a user assignment
User Assignment Collection: Retrieve or Delete a list of user assignments
New Page Assignment Creation: Retrieve, Update or Delete a page (form) assignment
Page Assignment Collection: Retrieve, Update or Delete a list of page (form) assignments
New Page Assignment Collection: Create new page (form) assignments

API 6.0

API 8.0

API 8.1

Page Resource

PLEASE NOTE: When using DELETE on a page, all records must be deleted first.

Page Resource includes the following:

Page: Retrieve, Update, Copy or Delete a page
Page Collection: Retrieve a list of pages
Page Feed: Retrieve the page feed
New Page Creation: Create a new page
Page Localization: Retrieve, Update or Delete a page localization
Page Localization Collection: Retrieve, Update or Delete a list of page localizations
New Page Localization Collection: Create new page localizations
Page Assignment: Retrieve, Update or Delete a page assignment
Page Assignment Collection: Retrieve, Update or Delete a list of page assignments
New Page Assignment Creation: Create new page assignments
Page Record Assignment: Retrieve or Delete record assignments
Page HTTP Callback: Retrieve, Update or Delete a page HTTP callback
Page HTTP Callback Collection: Retrieve or Delete a list of page HTTP callbacks
New Page HTTP Callback Creation: Create new page HTTP callbacks
Page Email Alert Collection: Retrieve or Delete a list of page email alerts
New Page Email Alert Creation: Create new page email alerts
- There is a character size limit of 1,000. When the email alert field is going to reach the limit, an error_message with "Too many emails" will appear in the response for the email address(es) that cannot be added. Please note that each time you post an email address, it will add to the list of email addresses already in the email alert field.
Trigger Record Post: Trigger POST action
Shared Page Collection: Retrieve, Update or Delete a shared page entry
New Shared Page Creation: Create new share page
Page Dynamic Attributes: Retrieve, Update or Delete a page dynamic attribute
Page Dynamic Attribute Collection: Retrieve, Update or Delete a list of page dynamic attributes
Create New Page Dynamic Attribute: Create new page attribute
- To find out what elements have dynamic attributes and what values are accepted, take a look here.

API 6.0

API 8.0

API 8.1

Page Group Resource

Page Group: Retrieve, Update or Delete a page group
Page Group Collection: Retrieve a list of page groups
New Page Group Creation: Create new page group
Page Group Page Assignment: Retrieve a page group page assignment, Assign page to page group or Delete page from page group
Page Group User Assignment: Retrieve, Update or Delete a list of page group user assignments
New Page Group User Assignment Creation: Create new page group assignments

API 6.0

API 8.0

API 8.1

Element Resource

PLEASE NOTE: When adding Smart Table Search to an element, smart_tbl_search and smart_tbl_search_col both have to be defined together and and must point to valid resources (form name, element name)

Element: Retrieve, Update, Copy or Delete an element
Element Collection: Retrieve, Update or Delete a list of elements
New Element Creation: Create new elements
Element Localization: Retrieve, Update or Delete a list of element localizations
Element Localization Collection: Retrieve, Update or Delete a list of element localizations
New Element Localization Creation: Create new element localizations
Element Dynamic Attributes: Retrieve, Update or Delete an element dynamic attribute
Element Dynamic Attribute Collection: Retrieve, Update or Delete a list of element dynamic attributes
Create New Element Dynamic Attribute: Create new element attribute
- To find out what elements have dynamic attributes and what values are accepted, take a look here.

API 6.0

API 8.0

API 8.1

Optionlist Resource

Optionlist: Retrieve, Update, Copy or Delete an optionlist
Optionlist Collection: Retrieve a list of optionlists
New Optionlist Creation: Create a new optionlist
Option: Retrieve, Update or Delete an option
Option Collection: Retrieve, Update or Delete a list of options
New Option Creation: Create new options
Option Localization: Retrieve, Update or Delete an option localization
Option Localization Collection: Retrieve, Update or Delete a list of option localizations
New Option Localization Creation: Create new option localizations

API 6.0

API 8.0

API 8.1

Record Resource

PLEASE NOTE: To search for null values in the API, you can put an empty string in search criteria. fields=first_name(="")

Record: Retrieve, Update, Copy or Delete a record
Record Collection: Retrieve, Update or Delete a list of records
New Record Creation: Create new records
- PLEASE NOTE: When creating records that have a parent relationship, you need to remember to set the count on the parent record which indicates the number of children for that element.
Record Assignment: Retrieve or Delete a record assignment
Record Assignment Collection: Retrieve or Delete a list of record assignments
New Record Assignment Creation: Create new record assignments