Skip to main content
Forms API (Application Programming Interface)

Streamline your data collection processes using our API

Shoshana Fleischmann avatar
Written by Shoshana Fleischmann
Updated over 2 months ago

By offering a dedicated Forms API, Connecteam enables seamless integration into external applications and systems. Businesses can automate data collection processes by extracting form submissions onto their own platforms, thus eliminating the need for manual data entry, minimizing error reduction, and saving valuable time and resources. This extracted data can be used for various purposes, such as generating reports, performing data analysis, or integrating with other business processes. In this article, we’ll go over what the Forms API offers and how to set up an API key in just a few easy steps.

What is an API?

An API, or Application Programming Interface, is a set of rules that allows different software applications to communicate with each other. It defines the methods and data structures that developers can use to build and integrate various software components, services, or systems.

Requirements for setting up an API: In-house/3rd party IT development capabilities

Please note: APIs are only available for Enterprise clients. If you are not on the Enterprise plan, this tab will not be available.

Before You Begin

Get familiar with the Forms feature. Understand how you can customize a form using the various field options provided and how users submit a form. In addition, learn about what manager fields are and how to set them up.

Check out our Starting Guide to Forms to start learning!

What We Offer

Retrieve all forms from Connecteam: Get all created forms from Connecteam right to your platform.

Retrieve a specific form: Get a specific form that were created in Connecteam.

Retrieve form submissions: Get all submitted forms from Connecteam right to your platform. For example, if users submit food orders on Connecteam, their responses are sent directly to documentation for payroll purposes. Another example is for employee referrals - a business that works with recruitment systems can grab responses and

immediately start working with the data.

Retrieve a specific form submission: If you need data from a specific form submission out of hundreds of entries, such as for compliance reasons, easy get it with a form id.

Update a form's manager field responses: This works with the following types of manager fields: person, status, note, and date. For instance, in the event of a security incident that’s reported on a submitted form, you can now change the status of the event directly from your platform, to ‘Working on it’ and promptly to ‘Done’.

View our API Documentation here.

We also offer a Webhook that allows you to export form submissions from Connecteam to another platform. View the Webhook documentation here.

How to Set Up an API Key

1. Go to your General Settings and navigate to the 'API keys' tab. This setting is accessible to owners only.

2. Click on ‘Add API key’

3. Add a key name and expiry date and time (optional)

4. Receive a code — that’s your API key.

This API key works with the Users, Job Scheduler, and Jobs API as well.

5. Copy it to your company’s internal systems to implement the connection.

To edit, disable, or delete the API key, click on the three dots and select the desired action.

*API is available for the Enterprise plan only*

Related Articles

Need more guidance? 🙋 Our LIVE support team (at the bottom right corner of your screen) replies in under 5 mins to ANY question.

Did this answer your question?