iFormBuilder API v8.1

Zerion Software • iformbuilder81
Help

Apiary Powered Documentation

Sign in with Apiary account.

iFormBuilder API v8.1

Introduction

For other versions of our API, take a look at our changelog page.

The main advantage in this version (v81) is the ability to let users define the responses. By only requesting key information, you can more efficiently use resources instead of retrieving a full API feed, and parsing out unused fields.

This approach can be used with any resource that doesn't specify an ID, such as a list of elements or users.

The documentation is broken down into resource categories and you can see formatted code samples for various languages in the console on the right.

Checkout our API Changelog and other Documentation.

Base URL to Make Requests

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

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 like https://api.iformbuilder.com/exzact/api/v80/app

General Notes

  • Most list based requests will return a maximum of 100 objects per request (Users, Assignments, Pages, Localizations, etc...) where as records and options will return up to 1000.
  • Default response will be returned when invalid grammar is passed into the request.
  • Field grammar can include filters (single or multiple conditions) and sort order.

    • Using Parameters

  • Parameters will allow you to refine the request and consist of the following:
  • fields: Allows you to specify which attributes are returned. Filter and sort priority can be assigned to each field.
  • limit: Allows you to specify how many results are returned.
  • offset: Allows you to specify number of results to skip.
  • validate_grammar:Returns an error for incorrect field grammar when set to true.
  • all_fields: When using list endpoints, setting this to 1 will return all fields for each object instead of just the defaul IDs.
  • exclude: Allows you to specific fields you don't want to return.
  • For example, this url would only provide the record ids.
    https://api.iformbuilder.com/exzact/api/v80/[servername]/profiles/10978/pages/290749032/records
  • This example demonstrates returning first name, last name, age, and state. This will also skip the first record only display 2 after that.
    https://api.iformbuilder.com/exzact/api/v80/[servername]/profiles/10978/pages/290749032/records?fields=first_name,last_name,residing_state,age&offset=1&limit=2
  • You can also specify which subform fields you want. In this example, we will have a subform called 'children_subform' with some fields in it.
    https://api.iformbuilder.com/exzact/api/v80/[servername]/profiles/10978/pages/290749032/records?fields=first_name,last_name,residing_state,age,children_subform[child_name,child_age,child_height]&offset=1&limit=2

    • Rate Limiting

  • To help protect the integrity of our system, we implemented rate limiting. When reaching our limit, the status code will be a 429 and the body will be {"error_message": "API rate limit exceeded"}
  • The limit is set to 100 calls per minute per endpoint. This means that you can send 100 requests a minute to both pages and user endpoints. However, making multiple calls to different resources in the same endpoint will be added to same total. Meaning, if you make 50 calls for /pages/12345/records and 50 calls to /pages/98765/records in a minute, you have reached the limit.
  • Feel free to contact us if the limits are affecting your workflow.

    • Sorting Fields

  • To sort by column(s), there are three components:
  • Column: The field you want to sort by
  • Operator: These consist of < (ascending) and > (descending)
  • Sort Priority: When sorting by multiple columns, you set priority by designating a number after the operator.
  • In this example, age has first priority in ascending order followed by first name in descending order.
    https://api.iformbuilder.com/exzact/api/v80/[servername]/profiles/10978/pages/290749032/records?fields=first_name:>2,age:<1

    • Filtering Fields

    Adding filters will narrow down your request output or input. This can be used with both GET and PUT requests.
    GET: Will return any data that meets your filter’s rules.
    PUT: Instead of updating a specific record, update many records that match the filter. For example, changing everyone who is now over 18 from child to an adult.

  • Three Components of Filtering
  • Column: The field you want to filter
  • Operator: These consist of <, <=, >, >=, = and ~
  • Value:The value you are basing your filter on. Boolean values can be passed in either as true and false, or 0 and 1.

    • Examples

  • Get everyone who is between 18 AND 65 (Note: the '&' symbol may need to be url encoded which is '%26')
    age((>="18")&(<="65"))

    or encoded
    age((>="18")%26(<="65"))
  • Get everyone that is younger than 18 OR older than 65
    age((>="18")|(<="65"))
  • Get all first names that start with 'K'
    first_name(~"K%")
  • Get all last names that end with 'son'
    last_name(~"%son")
  • Get all middle names that contain 'mit'
    middle_name(~"%mit%")
  • Now combining 4 examples above in a URL.
    https://api.iformbuilder.com/exzact/api/v80/[servername]/profiles/10978/pages/290749032/records?fields=age((>="18")|(<="65")),first_name(~"K%"),last_name(~"%son"),middle_name(~"%mit%")
  • Note: If trying to filter a field that is like a certain value that starts with a number, you have url encode the '%' symbol, otherwise the api will fail. If you wanted to search for a value that starts with 12 for exmaple:
    https://api.iformbuilder.com/exzact/api/v80/[servername]/profiles/10978/pages/290749032/records?fields=length(~"%2512")
  • Filter Multiple Fields with
  • To search a value inside multiple fields, you can use dashes to search multiple columns of the same value. For example,
  • Get all first names OR last names that start with 'K'
    first_name-last_name(~"K%")
  • Searching Multiple Specific Values
  • This will allow you to pass in multiple specifc values you want the query to return. Form example,
  • Get both records for ids 12345 AND 98765
    id(="12345"|="98765")

    • Request Access Token for Using API

  • To make requests to the API, you must obtain an access token. To obtain an a valid access token, click on the link below to get started.
  • Generating Access Token

    • Reference

    Token Resource

    Token

    Inspect Token Attributes

    Response
    object
    • client_id
      client id of the access token
      string, required
      2a05f76...4e26c0b
    • expires_in
      remaining time on the access token in seconds
      number, required
      1458
    • user
      owner of the access token
      object, required
    • user.username
      username of the authenticated user
      string, required
      calvinng
    • user.user_id
      user id of the authenticated user
      number, required
      161015
    • user.profile_id
      profile id of the authenticated user
      number, required
      161435

    Profile Resource

    Profile

    URI Parameters
    profile_idid of the profile

    Retrieve a Profile

    Response
    object
    • id
      number, required
      161521
    • name
      string, required
      iFormBuilder
    • global_id
      string, required
      0CP161521H14C19
    • version
      number, required
      1
    • address1
      string, required
      13665 Dulles Technology Dr., Suite 110
    • address2
      string, required
    • city
      string, required
      Herndon
    • zip
      string, required
      20171
    • state
      string, required
      VA
    • country
      string, required
      USA
    • phone
      string, required
      1-866-ZERION-1
    • fax
      string, required
    • email
      string, required
      support@iformbuilder.com
    • max_user
      number, required
      10
    • max_page
      number, required
      100
    • is_active
      boolean, required
      true
    • created_date
      string, required
      2015-04-21T14:33:58+00:00
    • type
      number, required
      -1
    • support_hours
      number, required
      0
    • time_zone
      string, required

    Update a Profile

    Request
    object
    • name
      string, optional
      iFormBuilder
    • address1
      string, optional
      13665 Dulles Technology Dr., Suite 110
    • address2
      string, optional
    • city
      string, optional
      Herndon
    • zip
      string, optional
      20171
    • state
      string, optional
      VA
    • country
      string, optional
      USA
    • phone
      string, optional
      1-866-ZERION-1
    • fax
      string, optional
    • email
      string, optional
      support@iformbuilder.com
    • max_user
      number, optional
      10
    • max_page
      number, optional
      100
    • is_active
      boolean, optional
      true
    • time_zone
      string, optional
    Response
    object
    • id
      the updated profile id
      number, required
      161521

    Company Info

    URI Parameters
    profile_idid of the profile

    Retrieve Company Info

    Response
    object
    • profile_id
      number, required
      161521
    • name
      string, required
      iFormBuilder
    • version
      number, required
      1
    • title
      string, required
      iFormBuilder Title
    • homemessage
      string, required
      <style type=...>
    • backgroundfilepath
      string, required
      path
    • faqurl
      string, required
      https://iformbuilder.zendesk.com/hc/en-us/articles/115003851826-Form-Properties-Frequently-Asked-Questions
    • homemessageurl
      string, required
      https://app.iformbuilder.com/exzact/adminHomeMessageTemplate1.php?PROFILE_ID=123456789
    • backgroundlink
      string, required
      https://backgroundlink.iformbuilder.com
    • last_updated
      string, required
      2018-08-17 10:41:12
    • app_idle_timeout
      number, required
      30
    • splash_link
      string, required
      https://splashlink.iformbuilder.com
    • donebutton_link
      string, required
      https://donebutton.iformbuilder.com
    • syncbutton_link
      string, required
      https://synclink.iformbuilder.com
    • base_color
      string, required
      #79AF64
    • top_text_color
      string, required
      #79AF64
    • text_color
      string, required
      #79AF64
    • text_hl_color
      string, required
      #79AF64
    • background2_link
      string, required
      https://backgroundlink2.iformbuilder.com
    • rsa_pub_key
      string, required
      -----BEGIN PUBLIC KEY-----\r\n
    • dropbox_access_token
      string, required
      xxxxxxxxx
    • dropbox_token_secret
      string, required
      xxxxxxxxx
    • dropbox_user_id
      number, required
      12332412
    • dropbox_media
      string, required
      0
    • dropbox_struct
      number, required
      0
    • media_location
      number, required
      0
    • records_downloads_size
      number, required
      55
    • addl_users_flg
      number, required
      1
    • button_text_color
      string, required
      '#79AF64`
    • show_submit_button
      number, required
      0
    • enable_button_text_color
      number, required
      2
    • signup_source
      string, required
      web
    • signup_field
      number, required
      4
    • webform_flg
      number, required
      1

    Update Company Info

    Response
    object
    • name
      string, optional
      iFormBuilder
    • title
      string, optional
      `iFormBuilder Title'
    • homemessage
      string, optional
      '<style type=...>'
    • backgroundfilepath
      string, optional
      path
    • faqurl
      string, optional
      https://iformbuilder.zendesk.com/hc/en-us/articles/115003851826-Form-Properties-Frequently-Asked-Questions
    • homemessageurl
      string, optional
      https://app.iformbuilder.com/exzact/adminHomeMessageTemplate1.php?PROFILE_ID=123456789
    • backgroundlink
      string, optional
      https://backgroundlink.iformbuilder.com
    • last_updated
      string, optional
      2018-08-17 10:41:12
    • app_idle_timeout
      number, optional
      30
    • splash_link
      string, optional
      https://splashlink.iformbuilder.com
    • donebutton_link
      string, optional
      https://donebutton.iformbuilder.com
    • syncbutton_link
      string, optional
      https://synclink.iformbuilder.com
    • base_color
      string, optional
      '#79AF64`
    • top_text_color
      string, optional
      '#79AF64`
    • text_color
      string, optional
      '#79AF64`
    • text_hl_color
      string, optional
      '#79AF64`
    • background2_link
      string, optional
      https://backgroundlink2.iformbuilder.com
    • rsa_pub_key
      string, optional
      -----BEGIN PUBLIC KEY-----\r\n
    • dropbox_access_token
      string, optional
      xxxxxxxxx
    • dropbox_token_secret
      string, optional
      xxxxxxxxx
    • dropbox_user_id
      number, optional
      12332412
    • dropbox_media
      string, optional
      0
    • dropbox_struct
      number, optional
      0
    • media_location
      number, optional
      0
    • records_downloads_size
      number, optional
      55
    • addl_users_flg
      number, optional
      1
    • button_text_color
      string, optional
      '#79AF64`
    • show_submit_button
      number, optional
      0
    • enable_button_text_color
      number, optional
      2
    • signup_source
      string, optional
      web
    • signup_field
      number, optional
      4
    • webform_flg
      number, optional
      1
    Response
    object
    • id
      the updated profile id
      number, required
      161521

    Profile Collection

    URI Parameters
    fieldsextra information of each profile on the list
    limitmaximum count of the profile list
    offsetskip that many profiles before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each the objects
    excludewill exclude specified fields

    Retrieve a List of Profiles

    Response
    object
    • id
      number, required
      161521
    • name
      string, required
      iFormBuilder
    • global_id
      string, optional
      0CP161521H14C19
    • version
      number, optional
      1
    • address1
      string, optional
      13665 Dulles Technology Dr., Suite 110
    • address2
      string, optional
    • city
      string, optional
      Herndon
    • zip
      string, optional
      20171
    • state
      string, optional
      VA
    • country
      string, optional
      USA
    • phone
      string, optional
      1-866-ZERION-1
    • fax
      string, optional
    • email
      string, optional
      support@iformbuilder.com
    • max_user
      number, optional
      10
    • max_page
      number, optional
      100
    • is_active
      boolean, optional
      true
    • created_date
      string, optional
      2015-04-21T14:33:58+00:00
    • type
      number, optional
      -1
    • support_hours
      number, optional
      0
    • time_zone
      string, optional

    New Profile Creation

    Create a New Profile

    Request
    object
    • name
      string, required
      iFormBuilder
    • address1
      string, optional
      13665 Dulles Technology Dr., Suite 110
    • address2
      string, optional
    • city
      string, optional
      Herndon
    • zip
      string, optional
      20171
    • state
      string, optional
      VA
    • country
      string, optional
      USA
    • phone
      string, optional
      1-866-ZERION-1
    • fax
      string, optional
    • email
      string, required
      support@iformbuilder.com
    • max_user
      number, required
      10
    • max_page
      number, required
      100
    • is_active
      boolean, required
      true
    • time_zone
      string, optional
    Response
    object
    • id
      the created profile id
      number, required
      161521

    User Resource

    User

    URI Parameters
    profile_idid of the profile
    user_idid of the user

    Retrieve a User

    Response
    object
    • id
      number, required
      161236
    • username
      string, required
      demo_user
    • global_id
      string, required
      0U161236HE9C19
    • first_name
      string, required
      Calvin
    • last_name
      string, required
      Ng
    • email
      string, required
      support@iformbuilder.com
    • roles
      object, required
    • created_date
      string, required
      2015-05-13T11:02:29+00:00
    • is_locked
      boolean, required
      false

    Update a User

    Request
    object
    • password
      string, optional
      testing123
    • first_name
      string, optional
      Calvin
    • last_name
      string, optional
      Ng
    • email
      string, optional
      support@iformbuilder.com
    • roles

      must match "server", "company" or "basic"

      string, optional
      server
    • can_form_edit
      boolean, optional
      true
    • can_thunderplug_sync
      boolean, optional
      true
    • is_locked
      Can only unlock user
      boolean, optional
      false
    Response
    object
    • id
      the updated user id
      number, required
      161236

    Delete a User

    Response
    object
    • id
      the deleted user id
      number, required
      161236

    User Collection

    URI Parameters
    profile_idid of the profile
    fieldsextra information of each user on the list
    limitmaximum count of the user list
    offsetskip that many users before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true

    Retrieve a List of Users

    Response
    object
    • id
      number, optional
      161236
    • username
      string, optional
      demo_user
    • global_id
      string, optional
      0U161236HE9C19
    • first_name
      string, optional
      Calvin
    • last_name
      string, optional
      Ng
    • email
      string, optional
      support@iformbuilder.com
    • roles
      object, optional
    • created_date
      string, optional
      2015-05-13T11:02:29+00:00
    • is_locked
      boolean, optional
      true

    Update a List of Users

    Request
    object
    • id
      number, optional
      161239
    • password
      string, optional
      testing123
    • first_name
      string, optional
      Calvin
    • last_name
      string, optional
      Ng
    • email
      string, optional
      support@iformbuilder.com
    • role

      must match "server", "company" or "basic"

      string, optional
      server
    • can_form_edit
      boolean, optional
      true
    • can_thunderplug_sync
      boolean, optional
      true
    • is_locked
      Can only unlock by using false
      boolean, optional
      false
    Response
    object
    • id
      the updated user id
      number, required
      161239
    Request
    object
    • id
      number, optional
      161239
    • password
      string, optional
      testing123
    • first_name
      string, optional
      Calvin
    • last_name
      string, optional
      Ng
    • email
      string, optional
      support@iformbuilder.com
    • role

      must match "server", "company" or "basic"

      string, optional
      server
    • can_form_edit
      boolean, optional
      true
    • can_thunderplug_sync
      boolean, optional
      true
    • is_locked
      Can only unlock by using false
      boolean, optional
      false
    Response
    object
    • id
      the updated user id
      number, required
      161239

    Delete a List of Users

    Request
    object
    • id
      number, optional
      161239
    Response
    object
    • id
      the deleted user id
      number, required
      161239
    Request
    object
    • id
      number, optional
      161239
    Response
    object
    • id
      the deleted user id
      number, required
      161239

    New User Creation

    URI Parameters
    profile_idid of the profile

    Create New Users

    Request
    object
    • username
      string, required
      demo_user
    • password
      string, required
      testing123
    • first_name
      string, optional
      Calvin
    • last_name
      string, optional
      Ng
    • email
      string, required
      support@iformbuilder.com
    • role

      must match "server", "company" or "basic"

      string, optional
      server
    • can_form_edit
      boolean, optional
      true
    • can_thunderplug_sync
      boolean, optional
      true
    Response
    object
    • id
      the created user id
      number, required
      161236
    Request
    object
    • username
      string, required
      demo_user
    • password
      string, required
      testing123
    • first_name
      string, optional
      Calvin
    • last_name
      string, optional
      Ng
    • email
      string, required
      support@iformbuilder.com
    • role

      must match "server", "company" or "basic"

      string, optional
      server
    • can_form_edit
      boolean, optional
      true
    • can_thunderplug_sync
      boolean, optional
      true
    Response
    object
    • id
      the created user id
      number, required
      161239
    Request
    object
    • username
      string, required
      demo_user
    • password
      string, required
      testing123
    • first_name
      string, optional
      Calvin
    • last_name
      string, optional
      Ng
    • email
      string, required
      support@iformbuilder.com
    • role

      must match "server", "company" or "basic"

      string, optional
      server
    • can_form_edit
      boolean, optional
      true
    • can_thunderplug_sync
      boolean, optional
      true

    Retrieve User Groups for Users

    Retrieve User Groups for Specifc User

    Response
    object
    • user_group_id
      number, required
      161236
    • user_group_name
      string, required
      demo_user

    Page Assignment

    URI Parameters
    profile_idid of the profile
    user_idid of the user
    page_idid of the page

    Retrieve a Page Assignment with Page/User ID

    Response
    object
    • page_id
      number, required
      790777
    • can_collect
      boolean, required
      true
    • can_view
      boolean, required
      true

    Update a Page Assignment with Page/User ID

    Request
    object
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the updated page id
      number, required
      790777

    Delete a Page Assignment with Page/User ID

    Response
    object
    • page_id
      the deleted page id
      number, required
      790777

    Page Assignment Collection

    URI Parameters
    profile_idid of the profile
    user_idid of the user
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    excludewill exclude specified fields
    all_fieldswill show all fields for the objects

    Retrieve a List of Page Assignments

    Response
    object
    • page_id
      number, required
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    • is_disabled
      boolean, optional
      true

    Update a List of Page Assignments

    Request
    object
    • page_id
      number, optional
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the updated page id
      number, required
      790771
    Request
    object
    • page_id
      number, optional
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the updated page id
      number, required
      790771

    Delete a List of Page Assignments

    Request
    object
    • page_id
      number, optional
      790771
    Response
    object
    • page_id
      the deleted page id
      number, required
      790771
    Request
    object
    • page_id
      number, optional
      790771
    Response
    object
    • page_id
      the deleted page id
      number, required
      790771

    New Page Assignment Creation

    URI Parameters
    profile_idid of the profile
    user_idid of the user

    Create New Page Assignments

    Request
    object
    • page_id
      number, required
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the created page id
      number, required
      790777
    Request
    object
    • page_id
      number, required
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the created page id
      number, required
      790777

    Record Assignment

    URI Parameters
    profile_idid of the profile
    user_idid of the user
    assignment_idid of the record assignment

    Retrieve a Record Assignment

    Response
    object
    • id
      number, required
      526
    • page_id
      number, required
      790777
    • record_id
      number, required
      4

    Delete a Record Assignment

    Response
    object
    • id
      the deleted assignment id
      number, required
      526

    Record Assignment Collection

    URI Parameters
    profile_idid of the profile
    user_idid of the user
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page assignment
    excludewill exclude specified fields

    Retrieve a List of Record Assignments

    Response
    object
    • id
      number, required
      526
    • page_id
      number, required
      790777
    • record_id
      number, required
      4

    Delete a List of Record Assignments

    Request
    object
    • id
      number, optional
      529
    Response
    object
    • id
      the deleted assignment id
      number, required
      529
    Request
    object
    • id
      number, optional
      529
    Response
    object
    • id
      the deleted assignment id
      number, required
      529

    New Record Assignment Creation

    URI Parameters
    profile_idid of the profile
    user_idid of the user

    Create New Record Assignments

    Request
    object
    • page_id
      number, required
      790777
    • record_id
      number, required
      4
    Response
    object
    • id
      the created assignment id
      number, required
      526
    Request
    object
    • page_id
      number, required
      790777
    • record_id
      number, required
      4
    Response
    object
    • id
      the created assignment id
      number, required
      526

    User Group Resource

    User Group

    URI Parameters
    profile_idid of the profile
    user_group_idid of the user group

    Retrieve a User Group

    Response
    object
    • id
      number, required
      161236
    • name
      string, required
      demo_group
    • global_id
      string, required
      0U161236HE9C19
    • version
      number, required
      95
    • created_date
      string, required
      2015-05-13T11:02:29+00:00
    • users
      array, required

    Update a User Group

    Request
    object
    • name
      string, optional
      testing123
    Response
    object
    • id
      the updated user group id
      number, required
      161236

    Delete a User Group

    Response
    object
    • id
      the deleted user group id
      number, required
      161236

    User Group Collection

    URI Parameters
    profile_idid of the profile
    fieldsextra information of each user on the list
    limitmaximum count of the user list
    offsetskip that many users before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each users
    excludewill exclude specified fields

    Retrieve a List of User Groups

    Response
    object
    • id
      number, required
      161236
    • name
      string, required
      demo_group
    • global_id
      string, optional
      0U161236HE9C19
    • version
      number, optional
      95
    • created_date
      string, optional
      2015-05-13T11:02:29+00:00
    • users
      array, optional

    New User Group Creation

    URI Parameters
    profile_idid of the profile

    Create New User Groups

    Request
    object
    • name
      string, required
      demo_user_group
    Response
    object
    • id
      the created user group id
      number, required
      161236

    User Assignment

    URI Parameters
    profile_idid of the profile
    user_group_idid of the user group
    user_idid of the user

    Retrieve a User Assignment

    Response
    object
    • user_id
      number, required
      155455
    • username
      string, required
      inspector

    Delete a User Assignment

    Response
    object
    • user_id
      the deleted user id
      number, required
      790777

    User Assignment Collection

    URI Parameters
    profile_idid of the profile
    user_group_idid of the user group
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page assignment
    excludewill exclude specified fields

    Retrieve a List of User Assignments

    Response
    object
    • user_id
      number, required
      790777
    • username
      string, required
      inspector

    Delete a List of Page Assignments

    Request
    object
    • user_id
      number, optional
      2734
    Response
    object
    • user_id
      the deleted user id
      number, required
      456124
    Request
    object
    • user_id
      number, optional
      2734
    Response
    object
    • user_id
      the deleted user id
      number, required
      456124

    New Page Assignment Creation

    URI Parameters
    profile_idid of the profile
    user_group_idid of the user group

    Create New User Assignments

    Request
    object
    • user_id
      number, required
      415215
    Response
    object
    • user_id
      the assigned user id
      number, required
      790777
    Request
    object
    • user_id
      number, required
      415215
    Response
    object
    • user_id

      the assigned user id(s)

      number, required
      790777

    Page Assignment

    URI Parameters
    profile_idid of the profile
    user_group_idid of the user group
    page_idid of the page

    Retrieve a Page Assignment

    Response
    object
    • page_id
      number, required
      790777
    • is_group
      boolean, required
      false
    • can_collect
      boolean, required
      true
    • can_view
      boolean, required
      true

    Update a Page Assignment

    Request
    object
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the updated page id
      number, required
      790777

    Delete a Page Assignment

    Response
    object
    • page_id
      the deleted page id
      number, required
      790777

    Page Assignment Collection

    URI Parameters
    profile_idid of the profile
    user_group_idid of the user group
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page assignment
    excludewill exclude specified fields

    Retrieve a List of Page Assignments

    Response
    object
    • page_id
      number, required
      790777
    • is_group
      boolean, optional
      true
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true

    Update a List of Page Assignments

    Request
    object
    • page_id
      number, optional
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the updated page id
      number, required
      790771
    Request
    object
    • page_id
      number, optional
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the updated page id
      number, required
      790771

    Delete a List of Page Assignments

    Request
    object
    • page_id
      number, optional
      790771
    Response
    object
    • page_id
      the deleted page id
      number, required
      790771
    Request
    object
    • page_id
      number, optional
      790771
    Response
    object
    • page_id
      the deleted page id
      number, required
      790771

    New Page Assignment Creation

    URI Parameters
    profile_idid of the profile
    user_group_idid of the user group

    Create New Page Assignments

    Request
    object
    • page_id
      number, required
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the created page id
      number, required
      790777
    Request
    object
    • page_id
      number, required
      790777
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • page_id
      the created page id
      number, required
      790777

    Page Resource

    General Notes:

  • When using DELETE on a page, all records must be deleted first.

    • Page

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Retrieve a Page

    Response
    object
    • id
      number, required
      790777
    • name
      string, required
      building_inspection
    • permissions
      object, required
    • permissions.modify
      boolean, required
      true
    • permissions.view
      boolean, required
      true
    • permissions.collect
      boolean, required
      true
    • permissions.shared
      boolean, required
      false
    • permissions.shared-subform
      boolean, required
      false
    • permissions.shared-lookup
      boolean, required
      false
    • global_id
      string, required
      0P790777H46FF3
    • label
      string, required
      Building Inspection
    • description
      string, required
      A form designed for building inspection
    • version
      number, required
      3
    • created_date
      string, required
      2015-05-12T11:27:14+00:00
    • created_by
      string, required
      cng
    • modified_date
      string, required
      2015-05-12T11:40:54+00:00
    • modified_by
      string, required
      cng
    • is_disabled
      boolean, required
      false
    • reference_id_1
      string, required
    • reference_id_2
      string, required
    • reference_id_3
      string, required
    • reference_id_4
      string, required
    • reference_id_5
      string, required
    • icon
      string, required
      https://dl.dropboxusercontent.com/u/53478059/Demo_Forms/icon_bldginsp.png
    • sort_order
      number, required
      0
    • page_javascript
      string, required
    • label_icons
      string, required
    • localizations
      array, required

    Update a Page

    Request
    object
    • name
      string, optional
      building_inspection
    • label
      string, optional
      Building Inspection
    • description
      string, optional
      A form designed for building inspection
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • reference_id_2
      string, optional
    • reference_id_3
      string, optional
    • reference_id_4
      string, optional
    • reference_id_5
      string, optional
    • icon
      string, optional
      https://dl.dropboxusercontent.com/u/53478059/Demo_Forms/icon_bldginsp.png
    • sort_order
      number, optional
      0
    • page_javascript
      string, optional
    • label_icons
      string, optional
    Response
    object
    • id
      the updated page id
      number, required
      790777

    Copy a Page

    Response
    object
    • id
      the copied page id
      number, required
      790777

    Delete a Page

    Response
    object
    • id
      the deleted page id
      number, required
      790777

    Page Collection

    URI Parameters
    profile_idid of the profile
    fieldsextra information of each page on the list
    limitmaximum count of the profile list
    offsetskip that many pages before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page
    excludewill exclude specified fields

    Retrieve a List of Pages

    Response
    object
    • id
      number, required
      790777
    • name
      string, required
      building_inspection
    • permissions
      object, required
    • permissions.modify
      boolean, required
      true
    • permissions.view
      boolean, required
      true
    • permissions.collect
      boolean, required
      true
    • permissions.shared
      boolean, required
      false
    • permissions.shared-subform
      boolean, required
      false
    • permissions.shared-lookup
      boolean, required
      false
    • global_id
      string, optional
      0P790777H46FF3
    • label
      string, optional
      Building Inspection
    • description
      string, optional
      A form designed for building inspection
    • version
      number, optional
      3
    • created_date
      string, optional
      2015-05-12T11:27:14+00:00
    • created_by
      string, optional
      cng
    • modified_date
      string, optional
      2015-05-12T11:40:54+00:00
    • modified_by
      string, optional
      cng
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • reference_id_2
      string, optional
    • reference_id_3
      string, optional
    • reference_id_4
      string, optional
    • reference_id_5
      string, optional
    • icon
      string, optional
      https://dl.dropboxusercontent.com/u/53478059/Demo_Forms/icon_bldginsp.png
    • sort_order
      number, optional
      0
    • page_javascript
      string, optional
    • label_icons
      string, optional
    • localizations
      array, optional

    Page Feed

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    deepreturn all of the subform records as well
    javascript_statewill exclude javascript state if set to 0

    Retrieve the page feed

    Response
    object
    • id
      number, required
      1
    • parent_record_id
      number, optional
      0
    • parent_page_id
      number, optional
      0
    • parent_element_id
      number, optional
      0
    • created_date
      string, optional
      2015-05-14T15:59:42+00:00
    • created_by
      string, optional
      cng
    • created_location
      string, optional
      API
    • created_device_id
      string, optional
      API
    • modified_date
      string, optional
      2015-05-14T16:08:21+00:00
    • modified_by
      string, optional
      cng
    • modified_location
      string, optional
      API
    • modified_device_id
      string, optional
      API
    • server_modified_date
      string, optional
      2015-05-14T16:08:21+00:00
    • javascript_state
      string, optional
      {}

    New Page Creation

    Create a New Page

    Request
    object
    • name
      string, required
      building_inspection
    • label
      string, required
      Building Inspection
    • description
      string, optional
      A form designed for building inspection
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • reference_id_2
      string, optional
    • reference_id_3
      string, optional
    • reference_id_4
      string, optional
    • reference_id_5
      string, optional
    • icon
      string, optional
      https://dl.dropboxusercontent.com/u/53478059/Demo_Forms/icon_bldginsp.png
    • sort_order
      number, optional
      0
    • page_javascript
      string, optional
    • label_icons
      string, optional
    Response
    object
    • id
      the created page id
      number, required
      790777

    Page Localization

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    language_codelanguage code of the localization

    Retrieve a Page Localization

    Response
    object
    • language_code
      string, required
      es
    • label
      string, required
      inspección de la construcción

    Update a Page Localization

    Request
    object
    • label
      string, optional
      inspección de la construcción
    Response
    object
    • language_code
      the updated language code
      string, required
      es

    Delete a Page Localization

    Response
    object
    • language_code
      the deleted language code
      string, required
      es

    Page Localization Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each page localization on the list
    limitmaximum count of the page localization list
    offsetskip that many page localization before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page localization
    excludewill exclude specified fields

    Retrieve a List of Page Localizations

    Response
    object
    • language_code
      string, required
      es
    • label
      string, required
      inspección de la construcción

    Update a List of Page Localizations

    Request
    object
    • language_code
      string, optional
      es
    • label
      string, optional
      inspección de la construcción
    Response
    object
    • language_code
      the updated language code
      string, required
      zh-hans

    Delete a List of Page Localizations

    Request
    object
    • language_code
      string, optional
      zh-hans
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans
    Request
    object
    • language_code
      string, optional
      zh-hans
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans

    New Page Localization Creation

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Create New Page Localizations

    Request
    object
    • language_code
      string, required
      es
    • label
      string, required
      inspección de la construcción
    Response
    object
    • language_code
      the created language code
      string, required
      es
    Request
    object
    • language_code
      string, required
      es
    • label
      string, required
      inspección de la construcción
    Response
    object
    • language_code
      the created language code
      string, required
      zh-hans

    Page Assignment

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    user_idid of the user

    Retrieve a Page Assignment

    Response
    object
    • user_id
      number, required
      161236
    • can_collect
      boolean, required
      true
    • can_view
      boolean, required
      true

    Update a Page Assignment

    Request
    object
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the updated user id
      number, required
      161236

    Delete a Page Assignment

    Response
    object
    • user_id
      the deleted user id
      number, required
      161236

    Page Assignment Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page assignment
    excludewill exclude specified fields

    Retrieve a List of Page Assignments

    Response
    object
    • user_id
      number, required
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true

    Update a List of Page Assignments

    Request
    object
    • user_id
      number, optional
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the updated user id
      number, required
      161239
    Request
    object
    • user_id
      number, optional
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the updated user id
      number, required
      161239

    Delete a List of Page Assignments

    Request
    object
    • user_id
      number, optional
      161239
    Response
    object
    • user_id
      the deleted user id
      number, required
      161239
    Request
    object
    • user_id
      number, optional
      161239
    Response
    object
    • user_id
      the deleted user id
      number, required
      161239

    New Page Assignment Creation

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Create New Page Assignments

    Request
    object
    • user_id
      number, required
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the created user id
      number, required
      161236
    Request
    object
    • user_id
      number, required
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the created user id
      number, required
      161236

    Page Record Assignment

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Retrieve Page Record Assignments

    Response
    object
    • id
      number, required
      790777
    • user_id
      number, required
      456
    • record_id
      number, required
      123
    • Body

      [ { "id": 270987, "user_id": 38265920, "record_id": 3662 }, { "id": 270990, "user_id": 38265867, "record_id": 3656 }, ]

      string

    Delete Page Record Assignments

    Response
    object
    • id
      number, required
      790777
    • Body

      [ { "id": 270987 } { "id": 270990 ]

      string

    Page HTTP Callback

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    http_callback_idid of the http callback

    Retrieve a Page HTTP Callback

    Response
    object
    • id
      number, required
      283
    • name
      string, required
      New Record Endpoint
    • url
      string, required
      https://www.iformbuilder.com/post_http_endpoint.php
    • feed_format

      must match "json" or "xml"

      string, required
      json
    • feed_format_version
      Must specifiy in URL parameter to retrieve
      string, optional
      10
    • trigger_post_email
      Must specifiy in URL parameter to retrieve
      string, optional
      support@iformbuilder.com
    • content_type: `header` (string, required) - must match "header" or "key_value_pair"
      string
    • key_value_pair_key (string, required) - required if content_type is "key_value_pair"
      string
    • error_email
      string, required
      support@iformbuilder.com
    • notification_email
      string, required
      support@iformbuilder.com
    • is_guaranteed_delivery
      boolean, required
      true
    • mode
      number, required
      0
    • secure_type
      string, required
      RS512
    • secure_key
      string, required
      -----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAhDZuORmHJDScMC66KwyU+3SBsgLLwTy/yjRgP-----END RSA PRIVATE KEY-----
    • is_disabled
      boolean, required
      true

    Update a Page HTTP Callback

    Request
    object
    • name
      string, optional
      New Record Endpoint
    • url
      string, optional
      https://www.iformbuilder.com/post_http_endpoint.php
    • feed_format

      must match "json" or "xml"

      string, optional
      json
    • feed_format_version
      must be 9 or 10.
      number, optional
      10
    • trigger_post_email
      string, optional
      support@iformbuilder.com
    • content_type: `header` (string, optional) - must match "header" or "key_value_pair"
      string
    • key_value_pair_key (string, optional) - reuqired if content_type is "key_value_pair"
      string
    • error_email
      must be valid email
      string, optional
      support@iformbuilder.com
    • notification_email
      must be valid email
      string, optional
      support@iformbuilder.com
    • is_guaranteed_delivery
      boolean, optional
      true
    • mode
      string, required
      'delete'
    • secure_type
      string, optional
      RS512
    • is_disabled
      boolean, optional
      false
    • secure_key
      string, required
      -----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAhDZuORmHJDScMC66KwyU+3SBsgLLwTy/yjRgP-----END RSA PRIVATE KEY-----
    Response
    object
    • id
      the updated page http callback id
      number, required
      283

    Delete a Page HTTP Callback

    Response
    object
    • id
      the deleted page http callback id
      number, required
      283

    Page HTTP Callback Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each option localization on the list
    limitmaximum count of the option localization list
    offsetskip that many option localization before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each option localization
    excludewill exclude specified fields

    Retrieve a List of Page HTTP Callbacks

    Response
    object
    • id
      number, required
      283
    • name
      string, required
      New Record Endpoint
    • url
      string, optional
      https://www.iformbuilder.com/post_http_endpoint.php
    • feed_format

      must match "json" or "xml"

      string, optional
      json
    • feed_format_version
      Must specifiy in URL parameter to retrieve
      string, optional
      10
    • content_type: `header` (string, optional) - must match "header" or "key_value_pair"
      string
    • key_value_pair_key (string, optional) - reuqired if content_type is "key_value_pair"
      string
    • error_email
      string, optional
      support@iformbuilder.com
    • notification_email
      string, optional
      support@iformbuilder.com
    • is_guaranteed_delivery
      boolean, optional
      true
    • mode
      string, optional
      'delete'
    • secure_type
      string, optional
      RS512
    • is_disabled
      boolean, optional
      false
    • trigger_post_email
      Must specifiy in URL parameter to retrieve
      string, optional
      support@iformbuilder.com
    • secure_key
      string, required
      -----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAhDZuORmHJDScMC66KwyU+3SBsgLLwTy/yjRgP-----END RSA PRIVATE KEY-----

    Delete a List of Page HTTP Callbacks

    Request
    object
    • id
      number, optional
      283
    Response
    object
    • id
      the deleted page http callback id
      number, required
      283
    Request
    object
    • id
      number, optional
      283
    Response
    object
    • id
      the deleted page http callback id
      number, required
      283

    New Page HTTP Callback Creation

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Create New Page HTTP Callbacks

    Request
    object
    • name
      string, required
      New Record Endpoint
    • url
      string, required
      https://www.iformbuilder.com/post_http_endpoint.php
    • feed_format

      must match "json" or "xml"

      string, required
      json
    • feed_format_version
      must be 9 or 10.
      number, optional
      10
    • content_type: `header` (string, required) - must match "header" or "key_value_pair"
      string
    • key_value_pair_key (string, optional) - reuqired if content_type is "key_value_pair"
      string
    • error_email
      must be valid email
      string, optional
      support@iformbuilder.com
    • notification_email
      must be valid email
      string, optional
      support@iformbuilder.com
    • is_guaranteed_delivery
      boolean, optional
      true
    • mode
      string, optional
      'delete'
    • secure_type
      string, optional
      RS512
    • is_disabled
      boolean, optional
      false
    • trigger_post_email `support@iformbuilder.com`
      string, optional
    • secure_key
      string, optional
      -----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAhDZuORmHJDScMC66KwyU+3SBsgLLwTy/yjRgP-----END RSA PRIVATE KEY-----
    Response
    object
    • id
      the created page http callback id
      number, required
      283

    Page Email Alert Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page assignment
    excludewill exclude specified fields

    Retrieve a List of Page Email Alerts

    Response
    object
    • email
      string, required
      support@iformbuilder.com

    Delete a List of Page Email Alerts

    Request
    object
    • email
      string, required
      support@iformbuilder.com
    Response
    object
    • email
      the deleted email alert
      string, required
      support@iformbuilder.com
    Request
    object
    • email
      string, required
      support@iformbuilder.com
    Response
    object
    • email
      the deleted email alert
      string, required
      support@iformbuilder.com

    New Page Email Alert Creation

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Create New Page Email Alerts

    Request
    object
    • email
      string, required
      support@iformbuilder.com
    Response
    object
    • email
      the created email alert
      string, required
      support@iformbuilder.com
    Request
    object
    • email
      string, required
      support@iformbuilder.com
    Response
    object
    • email
      the created email alert
      string, required
      support@iformbuilder.com

    Trigger Record Post

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Triggers POST Action

    Request
    object
    • id
      number, required
      91
    Response
    object
    • id
      causes post trigger
      number, required
      13
    Request
    object
    • id
      number, required
      91

    Shared Page Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page assignment
    excludewill exclude specified fields

    Retrieve a List of a Shared Page Entries

    Response
    object
    • id
      number, required
      86
    • profile_id
      string, required
      123456
    • allow_copy
      boolean, required
      false

    Update a Shared Page Entry

    Request
    object
    • id: 86 (number, required)
    Response
    object
    • id
      id of deleted shared page entry
      number, required
      86
    Request
    object
    • id: 86 (number, required)
    Response
    object
    • id
      id of deleted shared page entry
      number, required
      86

    Delete a Shared Page Entry

    Request
    object
    • id: 86 (number, required)
    Response
    object
    • id
      id of deleted shared page entry
      number, required
      86
    Request
    object
    • id: 86 (number, required)
    Response
    object
    • id
      id of deleted shared page entry
      number, required
      86

    New Shared Page Creation

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Create New Share Page

    Request
    object
    • profile_id
      number, required
      161675
    • allow_copy
      boolean, required
      true
    Response
    object
    • id
      the id of shared page entry
      number, required
      86
    Request
    object
    • profile_id
      number, required
      161675
    • allow_copy
      boolean, required
      true
    Response
    object
    • id
      ids of shared page entries
      number, required
      86

    Page Dynamic Attributes

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    dynamic_attributename of dynamic attribute

    Retrieve a Page Dynamic Attribute

    Response
    object
    • dynamic_attribute: `map_priority`
      string, required
    • value
      this value type can change based on dynamic attribute
      string, required
      my_element
    • type

      will display what type the value has to be, for example string or number

      string, required
      "string"
    • last_modified_date

      04-02T02:07:29+00:00" - Last time this attribute was modified

      string
      "2019

    Update an Page Dynamic Attribute

    Request
    object
    • value
      string, optional
      my_element2
    Response
    object
    • attribute_name: `map_priority`
      the updated dynamic attribute
      string, required

    Delete an Page Attribute

    Response
    object
    • attribute_name: `map_priority`

      the deleted dynamic_attribute

      string, required

    Page Attribute Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each page dynamic attribute on the list
    limitmaximum count of the page dynamic attribute list
    offsetskip that many page dynamic attribute before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page dynamic attribute
    excludewill exclude specified fields

    Page Dynamic Attribute Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each page dynamic attribute on the list
    limitmaximum count of the page dynamic attribute list
    offsetskip that many page dynamic attribute before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page dynamic attribute
    excludewill exclude specified fields

    Retrieve a List of Page Dynamic Attributes

    Response
    object
    • attribute_name: `12_24_hour_time`
      string, required
    • value
      returned value type can differ based on dynamic attribute
      string, required
      my_element

    Update a List of Page Dynamic Attributes

    Request
    object
    • attribute_name: `map_priority`
      string, required
    • value
      • value validation (ie. string or boolean) could change based on specific page dynamic attribute.
      string, required
      my_element2
    Response
    object
    • language_code
      the updated language code
      string, required
      zh-hans

    Delete a List of Page Dynamic Attributes

    Request
    object
    • attribute_name
      string, required
      ``
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans
    Request
    object
    • attribute_name
      string, required
      ``
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans

    Create New Page Dynamic Attribute

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Create New Page Attribute

    List of Valid Page Dynamic Attributes

  • To find out what elements have dynamic attributes and what values are accepted, take a look at our documentation.
    • Request
    object
    • attribute_name: `map_priority`
      string, required
    • value

      value validation (ie. string or boolean) could change based on specific page dynamic attribute.

      string, required
      my_element
    Response
    object
    • attribute_name: `map_priority`
      created page dynamic attribute
      string, required
    Request
    object
    • attribute_name: `map_priority`
      string, required
    • value

      value validation (ie. string or boolean) could change based on specific page dynamic attribute.

      string, required
      my_element
    Response
    object
    • attribute_name: `map_priority`
      created page dynamic attribute
      string, required

    Page Group Resource

    Page Group

    URI Parameters
    profile_idid of the profile
    page_group_idid of the page group

    Retrieve a Page Group

    Response
    object
    • id
      number, required
      777007
    • name
      string, required
      'my_form_group'
    • global_id
      string, required
      0Z420777H46AB3
    • version
      number, required
      3
    • created_date
      string, required
      2015-05-12T11:27:14+00:00
    • pages
      array, required

    Update a Page Group

    Request
    object
    • name
      string, optional
      building_inspection
    Response
    object
    • id
      the updated page group id
      number, required
      790777

    Delete a Page Group

    Response
    object
    • id
      the deleted page group id
      number, required
      790777

    Page Group Collection

    Retrieve a List of Page Groups

    URI Parameters
    profile_idid of the profile
    fieldsextra information of each user on the list
    limitmaximum count of the user list
    offsetskip that many users before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each users
    excludewill exclude specified fields
    Response
    object
    • id
      number, required
      790777
    • name
      string, required
      building_inspection
    • global_id
      string, optional
      0P790777H46FF3
    • version
      number, optional
      3
    • created_date
      string, optional
      2015-05-12T11:27:14+00:00
    • pages
      array, optional
    Response
    object
    • id
      number, required
      790777
    • name
      string, required
      building_inspection
    • global_id
      string, optional
      0P790777H46FF3
    • version
      number, optional
      3
    • created_date
      string, optional
      2015-05-12T11:27:14+00:00
    • pages
      array, optional

    New Page Group Creation

    URI Parameters
    profile_idid of the profile

    Create New Page Group

    Request
    object
    • name
      string, required
      demo_page_group
    Response
    object
    • id
      the created page group id
      number, required
      161236

    Page Group Page Assignment

    URI Parameters
    profile_idid of the profile
    page_group_idid of the page

    Retrieve a Page Group Page Assignment

    Response
    object
    • page_id
      number, required
      11261236
    • Body

      [ { "page_id": 11261236, } ]

      string

    Assign Page to Page Group

    Response
    object
    • page_id
      number, required
      11261236
    • Body

      [ { "page_id": 11261236
      }, { "page_id": 11261239
      } ]

      string

    Delete Page from Page Group

    Response
    object
    • page_id
      number, required
      11261236

    Page Group User Assignment

    URI Parameters
    profile_idid of the profile
    page_group_idid of the page
    user_idid of the user

    Retrieve a Page Group User Assignment

    Response
    object
    • user_id
      number, required
      161236
    • is_group
      boolean, required
      false
    • can_collect
      boolean, required
      true
    • can_view
      boolean, required
      true

    Update a Page Group User Assignment

    Request
    object
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the updated user id
      number, required
      161236

    Delete a Page Group User Assignment

    Response
    object
    • user_id
      the deleted user id
      number, required
      161236

    Page Group User Assignment Collection

    URI Parameters
    profile_idid of the profile
    page_group_idid of the page group
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page assignment
    excludewill exclude specified fields

    Retrieve a List of Page Group User Assignments

    Response
    object
    • user_id
      number, required
      161236
    • is_group
      boolean, optional
      false
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true

    Update a List of Page Group User Assignments

    Request
    object
    • user_id
      number, optional
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the updated user id
      number, required
      161239
    Request
    object
    • user_id
      number, optional
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the updated user id
      number, required
      161239

    Delete a List of Page Group's User Assignments

    Request
    object
    • user_id
      number, optional
      161239
    Response
    object
    • user_id
      the deleted user id
      number, required
      161239
    Request
    object
    • user_id
      number, optional
      161239
    Response
    object
    • user_id
      the deleted user id
      number, required
      161239

    New Page Group User Assignment Creation

    URI Parameters
    profile_idid of the profile
    page_group_idid of the page

    Create New Page Group Assignments

    Request
    object
    • user_id
      number, required
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the created user id
      number, required
      161236
    Request
    object
    • user_id
      number, required
      161236
    • can_collect
      boolean, optional
      true
    • can_view
      boolean, optional
      true
    Response
    object
    • user_id
      the created user id
      number, required
      161236

    Element Resource

    General Notes:

  • 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

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    element_idid of the element

    Retrieve an Element

    Response
    object
    • id
      number, required
      20483236
    • name
      string, required
      inspector_name
    • global_id
      string, required
      0E20483236H5971E
    • version
      number, required
      3
    • label
      string, required
      Inspector Name
    • description
      string, required
    • data_type
      number, required
      1
    • data_size
      number, required
      50
    • created_date
      string, required
      2015-05-12T14:38:35+00:00
    • created_by
      string, required
      cng
    • modified_date
      string, required
      2015-05-12T14:49:41+00:00
    • modified_by
      string, required
      cng
    • widget_type
      string, required
    • sort_order
      number, required
      1
    • optionlist_id
      number, required
      0
    • default_value
      string, required
    • low_value
      number, required
      0
    • high_value
      number, required
      0
    • dynamic_value
      string, required
      iformbuilder.username
    • is_required
      boolean, required
      false
    • condition_value
      string, required
    • client_validation
      string, required
    • is_disabled
      boolean, required
      false
    • reference_id_1
      string, required
    • reference_id_2
      string, required
    • reference_id_3
      string, required
    • reference_id_4
      string, required
    • reference_id_5
      string, required
    • attachment_link
      string, required
    • is_readonly
      boolean, required
      false
    • validation_message
      string, required
    • is_action
      boolean, required
      false
    • smart_tbl_search
      string, required
    • smart_tbl_search_col
      string, required
    • is_encrypt
      boolean, required
      false
    • is_hide_typing
      boolean, required
      false
    • on_change
      string, required
    • keyboard_type
      number, required
      1
    • dynamic_label
      string, required
    • weighted_score
      number, required
      0
    • localizations
      array, required

    Update an Element

    Request
    object
    • name
      string, optional
      inspector_name
    • label
      string, optional
      Inspector Name
    • description
      string, optional
    • data_type
      number, optional
      1
    • data_size
      number, optional
      50
    • widget_type
      string, optional
    • sort_order
      number, optional
      1
    • optionlist_id
      number, optional
      0
    • default_value
      string, optional
    • low_value
      number, optional
      0
    • high_value
      number, optional
      0
    • dynamic_value
      string, optional
      iformbuilder.username
    • is_required
      boolean, optional
      false
    • condition_value
      string, optional
    • client_validation
      string, optional
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • attachment_link
      string, optional
    • is_action
      boolean, optional
      true
    • is_readonly
      boolean, optional
      false
    • validation_message
      string, optional
    • smart_tbl_search
      string, optional
    • smart_tbl_search_col
      string, optional
    • is_encrypt
      boolean, optional
      false
    • is_hide_typing
      boolean, optional
      false
    • keyboard_type
      number, optional
      1
    • dynamic_label
      string, optional
    • weighted_score
      number, optional
      0
    Response
    object
    • id
      the updated element id
      number, required
      20483245

    Copy an Element

    Response
    object
    • id
      the copied element id
      number, required
      20483245

    Delete an Element

    Response
    object
    • id
      the deleted element id
      number, required
      20483245

    Element Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each element on the list
    limitmaximum count of the element list
    offsetskip that many elements before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each elements
    excludewill exclude specified fields

    Retrieve a List of Elements

    Response
    object
    • id
      number, required
      20483236
    • name
      string, required
      inspector_name
    • global_id
      string, optional
      0E20483236H5971E
    • version
      number, optional
      3
    • label
      string, optional
      Inspector Name
    • description
      string, optional
    • data_type
      number, optional
      1
    • data_size
      number, optional
      50
    • created_date
      string, optional
      2015-05-12T14:38:35+00:00
    • created_by
      string, optional
      cng
    • modified_date
      string, optional
      2015-05-12T14:49:41+00:00
    • modified_by
      string, optional
      cng
    • widget_type
      string, optional
    • sort_order
      number, optional
      1
    • optionlist_id
      number, optional
      0
    • default_value
      string, optional
    • low_value
      number, optional
      0
    • high_value
      number, optional
      0
    • dynamic_value
      string, optional
      iformbuilder.username
    • is_required
      boolean, optional
      false
    • condition_value
      string, optional
    • client_validation
      string, optional
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • attachment_link
      string, optional
    • is_readonly
      boolean, optional
      false
    • is_action
      boolean, optional
      true
    • validation_message
      string, optional
    • smart_tbl_search
      string, optional
    • smart_tbl_search_col
      string, optional
    • is_encrypt
      boolean, optional
      false
    • is_hide_typing
      boolean, optional
      false
    • keyboard_type
      number, optional
      1
    • dynamic_label
      string, optional
    • weighted_score
      number, optional
      0
    • localizations
      array, optional

    Update a List of Elements

    Request
    object
    • id
      number, optional
      20483236
    • name
      string, optional
      inspector_name
    • label
      string, optional
      Inspector Name
    • description
      string, optional
    • data_type
      number, optional
      1
    • data_size
      number, optional
      50
    • widget_type
      string, optional
    • sort_order
      number, optional
      1
    • optionlist_id
      number, optional
      0
    • default_value
      string, optional
    • low_value
      number, optional
      0
    • high_value
      number, optional
      0
    • dynamic_value
      string, optional
      iformbuilder.username
    • is_required
      boolean, optional
      false
    • condition_value
      string, optional
    • client_validation
      string, optional
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • attachment_link
      string, optional
    • is_readonly
      boolean, optional
      false
    • is_action
      boolean, optional
      true
    • validation_message
      string, optional
    • smart_tbl_search
      string, optional
    • smart_tbl_search_col
      string, optional
    • is_encrypt
      boolean, optional
      false
    • is_hide_typing
      boolean, optional
      false
    • keyboard_type
      number, optional
      1
    • dynamic_label
      string, optional
    • weighted_score
      number, optional
      0
    Response
    object
    • id
      the updated element id
      number, required
      20483236
    Request
    object
    • id
      number, optional
      20483236
    • name
      string, optional
      inspector_name
    • label
      string, optional
      Inspector Name
    • description
      string, optional
    • data_type
      number, optional
      1
    • data_size
      number, optional
      50
    • widget_type
      string, optional
    • sort_order
      number, optional
      1
    • optionlist_id
      number, optional
      0
    • default_value
      string, optional
    • low_value
      number, optional
      0
    • high_value
      number, optional
      0
    • dynamic_value
      string, optional
      iformbuilder.username
    • is_required
      boolean, optional
      false
    • condition_value
      string, optional
    • client_validation
      string, optional
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • attachment_link
      string, optional
    • is_readonly
      boolean, optional
      false
    • is_action
      boolean, optional
      true
    • validation_message
      string, optional
    • smart_tbl_search
      string, optional
    • smart_tbl_search_col
      string, optional
    • is_encrypt
      boolean, optional
      false
    • is_hide_typing
      boolean, optional
      false
    • keyboard_type
      number, optional
      1
    • dynamic_label
      string, optional
    • weighted_score
      number, optional
      0
    Response
    object
    • id
      the updated element id
      number, required
      20483236

    Delete a List of Elements

    Request
    object
    • id
      number, optional
      20483236
    Response
    object
    • id
      the deleted element id
      number, required
      20483236
    Request
    object
    • id
      number, optional
      20483236
    Response
    object
    • id
      the deleted element id
      number, required
      20483236

    New Element Creation

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Create New Elements

    Request
    object
    • name
      string, required
      inspector_name
    • label
      string, required
      Inspector Name
    • description
      string, optional
    • data_type
      number, required
      1
    • data_size
      number, optional
      50
    • widget_type
      string, optional
    • sort_order
      number, optional
      1
    • optionlist_id
      number, optional
      0
    • default_value
      string, optional
    • low_value
      number, optional
      0
    • high_value
      number, optional
      0
    • dynamic_value
      string, optional
      iformbuilder.username
    • is_required
      boolean, optional
      false
    • condition_value
      string, optional
    • client_validation
      string, optional
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • attachment_link
      string, optional
    • is_readonly
      boolean, optional
      false
    • is_action
      boolean, optional
      true
    • validation_message
      string, optional
    • smart_tbl_search
      string, optional
    • smart_tbl_search_col
      string, optional
    • is_encrypt
      boolean, optional
      false
    • is_hide_typing
      boolean, optional
      false
    • keyboard_type
      number, optional
      1
    • dynamic_label
      string, optional
    • weighted_score
      number, optional
      0
    Response
    object
    • id
      the created element id
      number, required
      20483233
    Request
    object
    • name
      string, required
      inspector_name
    • label
      string, required
      Inspector Name
    • description
      string, optional
    • data_type
      number, required
      1
    • data_size
      number, optional
      50
    • widget_type
      string, optional
    • sort_order
      number, optional
      1
    • optionlist_id
      number, optional
      0
    • default_value
      string, optional
    • low_value
      number, optional
      0
    • high_value
      number, optional
      0
    • dynamic_value
      string, optional
      iformbuilder.username
    • is_required
      boolean, optional
      false
    • condition_value
      string, optional
    • client_validation
      string, optional
    • is_disabled
      boolean, optional
      false
    • reference_id_1
      string, optional
    • attachment_link
      string, optional
    • is_readonly
      boolean, optional
      false
    • is_action
      boolean, optional
      true
    • validation_message
      string, optional
    • smart_tbl_search
      string, optional
    • smart_tbl_search_col
      string, optional
    • is_encrypt
      boolean, optional
      false
    • is_hide_typing
      boolean, optional
      false
    • keyboard_type
      number, optional
      1
    • dynamic_label
      string, optional
    • weighted_score
      number, optional
      0
    Response
    object
    • id
      the created element id
      number, required
      20483236

    Element Localization

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    element_idid of the element
    language_codelanguage code of the localization

    Retrieve an Element Localization

    Response
    object
    • language_code
      string, required
      es
    • label
      string, required
      nombre del Inspector

    Update an Element Localization

    Request
    object
    • label
      string, optional
      nombre del Inspector
    Response
    object
    • language_code
      the updated language code
      string, required
      es

    Delete a Element Localization

    Response
    object
    • language_code
      the deleted language code
      string, required
      es

    Element Localization Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    element_idid of the element
    fieldsextra information of each element localization on the list
    limitmaximum count of the element localization list
    offsetskip that many element localization before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each element localization
    excludewill exclude specified fields

    Retrieve a List of Element Localizations

    Response
    object
    • language_code
      string, required
      es
    • label
      string, required
      nombre del Inspector

    Update a List of Element Localizations

    Request
    object
    • language_code
      string, optional
      es
    • label
      string, optional
      nombre del Inspector
    Response
    object
    • language_code
      the updated language code
      string, required
      zh-hans

    Delete a List of Element Localizations

    Request
    object
    • language_code
      string, optional
      zh-hans
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans
    Request
    object
    • language_code
      string, optional
      zh-hans
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans

    New Element Localization Creation

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    element_idid of the element

    Create New Element Localizations

    Request
    object
    • language_code
      string, required
      es
    • label
      string, required
      nombre del Inspector
    Response
    object
    • language_code
      the created language code
      string, required
      es
    Request
    object
    • language_code
      string, required
      es
    • label
      string, required
      nombre del Inspector
    Response
    object
    • language_code
      the created language code
      string, required
      zh-hans

    Element Dynamic Attributes

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    element_idid of the element
    dynamic_attributename of dynamic attribute

    Retrieve an Element Dynamic Attribute

    Response
    object
    • dynamic_attribute: `12_24_hour_time`
      string, required
    • value
      this value type can change based on dynamic attribute
      string, required
      12hr
    • type

      will display what type the value has to be, for example string or number

      string, required
      "string"
    • last_modified_date

      04-02T02:07:29+00:00" - Last time this attribute was modified

      string
      "2019

    Update an Element Dynamic Attribute

    Request
    object
    • value
      string, optional
      24hr
    Response
    object
    • attribute_name: `12_24_hour_time`
      the updated dynamic attribute
      string, required

    Delete an Element Attribute

    Response
    object
    • attribute_name: `12_24_hour_time`

      the deleted dynamic_attribute

      string, required

    Element Attribute Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    element_idid of the element
    fieldsextra information of each element dynamic attribute on the list
    limitmaximum count of the element dynamic attribute list
    offsetskip that many element dynamic attribute before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each element dynamic attribute
    excludewill exclude specified fields

    Element Dynamic Attribute Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    element_idid of the element
    fieldsextra information of each element dynamic attribute on the list
    limitmaximum count of the element dynamic attribute list
    offsetskip that many element dynamic attribute before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each element dynamic attribute
    excludewill exclude specified fields

    Retrieve a List of Element Dynamic Attributes

    Response
    object
    • attribute_name: `12_24_hour_time`
      string, required
    • value
      returned value type can differ based on dynamic attribute
      string, required
      12hr

    Update a List of Element Dynamic Attributes

    Request
    object
    • attribute_name: `12_24_hour_time`
      string, required
    • value
      • value validation (ie. string or boolean) could change based on specific element dynamic attribute.
      string, required
      24hr
    Response
    object
    • attribute_name: `12_24_hour_time`
      the updated attribute name
      string, required

    Delete a List of Element Dynamic Attributes

    Request
    object
    • attribute_name
      string, required
      ``
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans
    Request
    object
    • attribute_name
      string, required
      ``
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans

    Create New Element Dynamic Attribute

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    element_idid of the element

    Create New Element Attribute

    List of Valid Element Dynamic Attributes

  • To find out what elements have dynamic attributes and what values are accepted, take a look here.
    • Request
    object
    • attribute_name: `12_24_hour_time`
      string, required
    • value

      value validation (ie. string or boolean) could change based on specific element dynamic attribute.

      string, required
      12hr
    Response
    object
    • attribute_name
      created element dynamic attribute
      string, required
      es
    Request
    object
    • attribute_name: `12_24_hour_time`
      string, required
    • value

      value validation (ie. string or boolean) could change based on specific element dynamic attribute.

      string, required
      12hr
    Response
    object
    • attribute_name: `12_24_hour_time`
      created element dynamic attribute
      string, required

    Optionlist Resource

    Optionlist

    URI Parameters
    profile_idid of the profile
    optionlist_idid of the optionlist

    Retrieve an Optionlist

    Response
    object
    • id
      number, required
      393655
    • name
      string, required
      System Grade
    • global_id
      string, required
      0OL393655H6488B
    • version
      number, required
      3
    • created_date
      string, required
      2015-05-12T22:04:03+00:00
    • created_by
      string, required
      cng
    • modified_date
      string, required
      2015-05-12T22:08:45+00:00
    • modified_by
      string, required
      cng
    • reference_id
      string, required
    • option_icons
      string, required
      dropbox://iForm

    Update an Optionlist

    Request
    object
    • name
      string, optional
      System Grade
    • reference_id
      string, optional
    • option_icons
      string, optional
      dropbox://iForm
    Response
    object
    • id
      the updated optionlist id
      number, required
      393655

    Copy an Optionlist

    Response
    object
    • id
      the copied optionlist id
      number, required
      393655

    Delete an Optionlist

    Response
    object
    • id
      the deleted optionlist id
      number, required
      393655

    Optionlist Collection

    URI Parameters
    profile_idid of the profile
    fieldsextra information of each optionlist on the list
    limitmaximum count of the optionlist list
    offsetskip that many optionlists before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each optionlists
    excludewill exclude specified fields

    Retrieve a List of Optionlists

    Response
    object
    • id
      number, required
      393655
    • name
      string, required
      System Grade
    • global_id
      string, optional
      0OL393655H6488B
    • version
      number, optional
      3
    • created_date
      string, optional
      2015-05-12T22:04:03+00:00
    • created_by
      string, optional
      cng
    • modified_date
      string, optional
      2015-05-12T22:08:45+00:00
    • modified_by
      string, optional
      cng
    • reference_id
      string, optional
    • option_icons
      string, optional
      dropbox://iForm

    New Optionlist Creation

    URI Parameters
    profile_idid of the profile

    Create New a New Optionlist

    Request
    object
    • name
      string, required
      System Grade
    • reference_id
      string, optional
    • option_icons
      string, optional
      dropbox://iForm
    Response
    object
    • id
      the created option list id
      number, required
      393655

    Option

    URI Parameters
    profile_idid of the profile
    optionlist_idid of the option list
    option_idid of the option

    Retrieve an Option

    Response
    object
    • id
      number, required
      268623880
    • key_value
      string, required
      na
    • global_id
      string, required
      0O268623880HD6ED5
    • label
      string, required
      N/A
    • sort_order
      number, required
      0
    • condition_value
      string, required
      false
    • score
      number, required
      0
    • localizations
      array, required

    Update an Option

    Request
    object
    • key_value
      string, optional
      na
    • label
      string, optional
      N/A
    • sort_order
      number, optional
      0
    • condition_value
      string, optional
      false
    • score
      number, optional
      0
    Response
    object
    • id
      the updated option id
      number, required
      268623880

    Delete an Option

    Response
    object
    • id
      the deleted option id
      number, required
      268623880

    Option Collection

    URI Parameters
    profile_idid of the profile
    optionlist_idid of the option list
    fieldsextra information of each profile on the list
    limitmaximum count of the profile list
    offsetskip that many profiles before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each profiles
    excludewill exclude specified fields

    Retrieve a List of Options

    Response
    object
    • id
      number, required
      268623880
    • key_value
      string, required
      na
    • global_id
      string, optional
      0O268623880HD6ED5
    • label
      string, optional
      N/A
    • sort_order
      number, optional
      0
    • condition_value
      string, optional
      false
    • score
      number, optional
      0
    • localizations
      array, optional

    Update a List of Options

    Request
    object
    • id
      number, optional
      268623880
    • key_value
      string, optional
      na
    • label
      string, optional
      N/A
    • sort_order
      number, optional
      0
    • condition_value
      string, optional
      false
    • score
      number, optional
      0
    Response
    object
    • id
      the updated option id
      number, required
      268623880
    Request
    object
    • id
      number, optional
      268623880
    • key_value
      string, optional
      na
    • label
      string, optional
      N/A
    • sort_order
      number, optional
      0
    • condition_value
      string, optional
      false
    • score
      number, optional
      0
    Response
    object
    • id
      the updated option id
      number, required
      268623880

    Delete a List of Options

    Request
    object
    • id
      number, optional
      268623880
    Response
    object
    • id
      the deleted option id
      number, required
      268623880
    Request
    object
    • id
      number, optional
      268623880
    Response
    object
    • id
      the deleted option id
      number, required
      268623880

    New Option Creation

    URI Parameters
    profile_idid of the profile
    optionlist_idid of the option list

    Create New Options

    Request
    object
    • key_value
      string, required
      na
    • label
      string, required
      N/A
    • sort_order
      number, optional
      0
    • condition_value
      string, optional
      false
    • score
      number, optional
      0
    Response
    object
    • id
      the created option id
      number, required
      268623880
    Request
    object
    • key_value
      string, required
      na
    • label
      string, required
      N/A
    • sort_order
      number, optional
      0
    • condition_value
      string, optional
      false
    • score
      number, optional
      0
    Response
    object
    • id
      the created option id
      number, required
      268623883

    Option Localization

    URI Parameters
    profile_idid of the profile
    optionlist_idid of the optionlist
    option_idid of the option
    language_codelanguage code of the localization

    Retrieve a Option Localization

    Response
    object
    • language_code
      string, required
      es
    • label
      string, required
      fallar

    Update a Option Localization

    Request
    object
    • label
      string, optional
      fallar
    Response
    object
    • language_code
      the updated language code
      string, required
      es

    Delete a Option Localization

    Response
    object
    • language_code
      the deleted language code
      string, required
      es

    Option Localization Collection

    URI Parameters
    profile_idid of the profile
    optionlist_idid of the optionlist
    option_idid of the option
    fieldsextra information of each option localization on the list
    limitmaximum count of the option localization list
    offsetskip that many option localization before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each option localization
    excludewill exclude specified fields

    Retrieve a List of Option Localizations

    Response
    object
    • language_code
      string, required
      es
    • label
      string, required
      fallar

    Update a List of Option Localizations

    Request
    object
    • language_code
      string, optional
      es
    • label
      string, optional
      fallar
    Response
    object
    • language_code
      the updated language code
      string, required
      zh-hans

    Delete a List of Option Localizations

    Request
    object
    • language_code
      string, optional
      zh-hans
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans
    Request
    object
    • language_code
      string, optional
      zh-hans
    Response
    object
    • language_code
      the deleted language code
      string, required
      zh-hans

    New Option Localization Creation

    URI Parameters
    profile_idid of the profile
    optionlist_idid of the optionlist
    option_idid of the option

    Create New Option Localizations

    Request
    object
    • language_code
      string, required
      es
    • label
      string, required
      fallar
    Response
    object
    • language_code
      the created language code
      string, required
      es
    Request
    object
    • language_code
      string, required
      es
    • label
      string, required
      fallar
    Response
    object
    • language_code
      the created language code
      string, required
      zh-hans

    Record Resource

    General Notes:

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

    • Record

    Retrieve a Record

    URI Parameters
    subform_order

    order of subform records. Use 'asc' or 'desc'.

    profile_idid of the profile
    page_idid of the page
    record_idid of the record
    Response
    object
    • id
      number, required
      1
    • parent_record_id
      number, required
      0
    • parent_page_id
      number, required
      0
    • parent_element_id
      number, required
      0
    • created_date
      string, required
      2015-05-14T15:59:42+00:00
    • created_by
      string, required
      cng
    • created_location
      string, required
      API
    • created_device_id
      string, required
      API
    • modified_date
      string, required
      2015-05-14T16:08:21+00:00
    • modified_by
      string, required
      cng
    • modified_location
      string, required
      API
    • modified_device_id
      string, required
      API
    • server_modified_date
      string, required
      2015-05-14T16:08:21+00:00
    • javascript_state
      string, required
      {}

    Update a Record

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    record_idid of the record
    Request
    object
    • fields
      an array that contains record fields
      array, optional
    • fields.element_name: `inspector_name`

      must have either element_name or element_id set

      string, optional
    • fields.element_id
      number, optional
      2048326
    • fields.value
      string, required
      Calvin Ng
    • fields.extension

      file extension, if applicable

      string, optional
      jpg
    • fields.encoding

      must match "base64", "url"

      string, optional
      url
    • device_id
      string, optional
      API
    • javascript_state
      string, optional
      {}
    Response
    object
    • id
      the updated record id
      number, required
      1

    Copy a Record

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    record_idid of the record
    Response
    object
    • id
      the deleted record id
      number, required
      1

    Delete a Record

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    record_idid of the record
    Response
    object
    • id
      the deleted record id
      number, required
      1

    Record Collection

    Retrieve a List of Records

    URI Parameters
    subform_order

    order of subform records. Use 'asc' or 'desc'.

    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each record on the list
    limitmaximum count of the record list
    offsetskip that many record before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each record
    excludewill exclude specified fields
    Response
    object
    • id
      number, required
      1
    • parent_record_id
      number, optional
      0
    • parent_page_id
      number, optional
      0
    • parent_element_id
      number, optional
      0
    • created_date
      string, optional
      2015-05-14T15:59:42+00:00
    • created_by
      string, optional
      cng
    • created_location
      string, optional
      API
    • created_device_id
      string, optional
      API
    • modified_date
      string, optional
      2015-05-14T16:08:21+00:00
    • modified_by
      string, optional
      cng
    • modified_location
      string, optional
      API
    • modified_device_id
      string, optional
      API
    • server_modified_date
      string, optional
      2015-05-14T16:08:21+00:00
    • javascript_state
      string, optional
      {}

    Update a List of Records

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each record on the list
    limitmaximum count of the record list
    offsetskip that many record before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each record
    excludewill exclude specified fields
    Request
    object
    • id
      number, optional
      4
    • fields
      an array that contains record fields
      array, optional
    • fields.element_name: `inspector_name`

      must have either element_name or element_id set

      string, optional
    • fields.element_id
      string, optional
      20483236
    • fields.value
      string, required
      Calvin Ng
    • fields.extension

      file extension, if applicable

      string, optional
      jpg
    • fields.encoding

      must match "base64", "url"

      string, optional
      url
    • device_id
      string, optional
      API
    • javascript_state
      string, optional
      {}
    Response
    object
    • id
      the updated record id
      number, required
      4
    Request
    object
    • id
      number, optional
      4
    • fields
      an array that contains record fields
      array, optional
    • fields.element_name: `inspector_name`

      must have either element_name or element_id set

      string, optional
    • fields.element_id
      string, optional
      20483236
    • fields.value
      string, required
      Calvin Ng
    • fields.extension

      file extension, if applicable

      string, optional
      jpg
    • fields.encoding

      must match "base64", "url"

      string, optional
      url
    • device_id
      string, optional
      API
    • javascript_state
      string, optional
      {}
    Response
    object
    • id
      the updated record id
      number, required
      4

    Delete a List of Records

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    fieldsextra information of each record on the list
    limitmaximum count of the record list
    offsetskip that many record before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each record
    excludewill exclude specified fields
    Request
    object
    • id
      number, optional
      4
    Response
    object
    • id
      the deleted record id
      number, required
      4
    Request
    object
    • id
      number, optional
      4
    Response
    object
    • id
      the deleted record id
      number, required
      4

    New Record Creation

    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.

    URI Parameters
    profile_idid of the profile
    page_idid of the page

    Create New Records

    Request
    object
    • parent_record_id
      number, optional
      0
    • parent_page_id
      number, optional
      0
    • parent_element_id
      number, optional
      0
    • fields
      an array that contains record fields
      array, optional
    • fields.element_name: `inspector_name`

      must have either element_name or element_id set

      string, optional
    • fields.element_id
      string, optional
      20483236
    • fields.value
      string, required
      Calvin Ng
    • fields.extension

      file extension, if applicable

      string, optional
      jpg
    • fields.encoding

      must match "base64", "url"

      string, optional
      url
    • device_id
      string, optional
      API
    • javascript_state
      string, optional
      {}
    Response
    object
    • id
      the created record id
      number, required
      1
    Request
    object
    • parent_record_id
      number, optional
      0
    • parent_page_id
      number, optional
      0
    • parent_element_id
      number, optional
      0
    • fields
      an array that contains record fields
      array, optional
    • fields.element_name: `inspector_name`

      must have either element_name or element_id set

      string, optional
    • fields.element_id
      string, optional
      20483236
    • fields.value
      string, required
      Calvin Ng
    • fields.extension

      file extension, if applicable

      string, optional
      jpg
    • fields.encoding

      must match "base64", "url"

      string, optional
      url
    • device_id
      string, optional
      API
    • javascript_state
      string, optional
      {}
    Response
    object
    • id
      the created record id
      number, required
      4

    Record Assignment

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    record_idid of the record
    user_idid of the user

    Retrieve a Record Assignment

    Response
    object
    • user_id
      number, required
      161236

    Delete a Record Assignment

    Response
    object
    • user_id
      the deleted user id
      number, required
      161236

    Record Assignment Collection

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    record_idid of the record
    fieldsextra information of each page assignment on the list
    limitmaximum count of the page assignment list
    offsetskip that many page assignment before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each page assignment
    excludewill exclude specified fields

    Retrieve a List of Record Assignments

    Response
    object
    • user_id
      number, required
      161236

    Delete a List of Record Assignments

    Request
    object
    • user_id
      number, optional
      161239
    Response
    object
    • user_id
      the deleted user id
      number, required
      161239
    Request
    object
    • user_id
      number, optional
      161239
    Response
    object
    • user_id
      the deleted user id
      number, required
      161239

    New Record Assignment Creation

    URI Parameters
    profile_idid of the profile
    page_idid of the page
    record_idid of the record

    Create New Record Assignments

    Request
    object
    • user_id
      Must provide user id or username
      number, optional
      161236
    • username
      Must provide user id or username
      string, optional
      user
    Response
    object
    • user_id
      the created user id
      number, required
      161236
    Request
    object
    • user_id
      Must provide user id or username
      number, optional
      161236
    • username
      Must provide user id or username
      string, optional
      user
    Response
    object
    • user_id
      the created user id
      number, required
      161236

    Notification Resource

    Notification

    Send Notifications

    Request
    object
    • message
      string, required
      Please sync to update form
    • users
      array, required[string]
    Response
    object
    • id
      The user id the message is sent to.
      array, required[string]
    Request
    object
    • message
      string, required
      Please sync to update form
    • users
      array, required[string]
    Response
    object
    • id
      the created user id
      number, required
      2435467

    Private Media Resource

    Media

    Get Media

    Device License Resource

    Device License

    URI Parameters
    profile_idid of the profile
    license_idid of the device license

    Retrieve a Device License

    Response
    object
    • id
      number, required
      198392
    • username
      string, required
      demo_user
    • device_id
      string, required
      d174b4c64f6f358a3b19bfca4558eb1d9d3e265f
    • device_last_login_user: `demo_user`
      string, required
    • device_last_login_date
      string, required
      2019-05-23T15:52:15+00:00
    • device_notification_token
      string, required
      78f48ac3 6765c07c 0d53bbd7 97d6b61b 0e9d50ee e5d7522e 06bb8787 870e26fb
    • device_model
      string, required
      iPad Pro
    • device_system_version
      string, required
      12.1.1
    • application_name
      string, required
      iForm
    • application_version
      string, required
      8.32.0

    Device License Collection

    URI Parameters
    profile_idid of the profile
    fieldsextra information of each user on the list
    limitmaximum count of the user list
    offsetskip that many users before beginning to return
    validate_grammarreturns an error for incorrect field grammar when set to true
    all_fieldswill show all fields for each users
    excludewill exclude specified fields

    Retrieve a List of Device Licenses

    Response
    object
    • id
      number, required
      161236
    • username
      string, required
      demo_user
    • device_id
      string, required
      d174b4c64f6f358a3b19bfca4558eb1d9d3e265f
    • device_last_login_user: `demo_user`
      string, optional
    • device_last_login_date
      string, optional
      2019-05-23T15:52:15+00:00
    • device_notification_token
      string, optional
      78f48ac3 6765c07c 0d53bbd7 97d6b61b 0e9d50ee e5d7522e 06bb8787 870e26fb
    • device_model
      string, optional
      iPad Pro
    • device_system_version
      string, optional
      12.1.1
    • application_name
      string, optional
      iForm
    • application_version
      string, optional
      8.32.0