General Information

General Information

We provide an Application Programming Interface (API) for programmatic access to data hosted on the platform.
This document outlines the API and is intended for software developers and systems integrators.

The API is exposed using web services in a REST approach, providing a flexible and simple set of interfaces that can be accessed from just about any programming language.

Our platform was built to integrate. Thus, robust two-way data transfer is supported on several objects exposed.

All APIs support both JSON and raw XML formats.

XML requests must each have a tag element in alphabetical order.

To access the various APIs, you must use the generated Integration keys, which can be found on the website’s Provider configuration page.

Keep this Integration key safe since it is the key to keeping your data secure during API communication.

The base URL for all Cloud APIs is https://eforms.mobileform.net/api/v2

If you are running Appenate Server, the API will be available from the installed Server website’s root URL with the “/api/v2” suffix.

General Data Type Notes

  • If not explicitly stated, date values are expected to be formatted using the ISO-8601 format:
    YYYY-MM-DDTHH:MI:SSZ
    Where the time zone is UTC, the time is in 24-hour values, and the “T” and “Z” are delimiters.
  • All latitude and longitude data values are unprojected and use the WGS84 ellipsoid.

API HTTP Status Codes

We don’t use many HTTP codes on our API; our error messages are generally included in the response body.

Generally speaking, successful API calls will return a 200 HTTP code.

If the API call has an error result, you will get one of the following.

HTTP Response CodeHTTP Response Details
400Bad Request – this occurs when missing or invalid parameters are submitted in the request.
405Method Not Allowed – this occurs if the API endpoint you are attempting to call does not exist.
401Unauthorized – your integration key or company id is not valid.
500All other errors usually are returned under a 500 Internal Server Error.

As mentioned above, if you get one of the above HTTP error codes, the response body will include more details of the error.

    • Related Articles

    • POST Repository API (Create)

      The POST Repository API registers new content from a company account into the Repository. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response ...

    • GET Task Recurring

      This request method allows you to find the recurring task matching the given criteria. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response ...

    • Tips for REST Integrations

      While we can’t offer you advice on programming your web service, below are some tips on how to best configure and test your work. Re-running REST connectors When testing your web service against incoming data from our platform, you’ll likely need our ...

    • API Usage Limits

      Calls to our API are limited to 2500 per day per organization account to avoid abuse or negligent integrations that degrade platform performance. API limits are reset upon the first API request made after midnight in the time zone specified on your ...

    • POST Task Recurring

      This request method allows you to create a recurring task and assign it to a specified user(s). On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired ...