Table of Contents

Still need help?

Clappia Public APIs Documentation

Clappia provides RESTful APIs that allow you to send data directly to your Clappia apps using HTTP POST requests with a JSON payload. These APIs enable seamless integration between Clappia and other external systems, automating processes and enhancing data flow.

With public APIs, you can:

Submit data to Clappia apps programmatically.
Automate data entry and workflows.
Integrate external applications and services with Clappia.

Generating an API Key for Your Workplace

To use the public APIs, you need an API key specific to your workplace. The API key acts as an authentication token to ensure secure interaction with the APIs.

Steps to Generate an API Key

Go to Workplace Settings > Preferences tab > Select API Keys.

Click on Generate API Key. A unique API key for your workplace will be created.

Once generated, you will see the API key.

Important Notes:

Copy the API key and store it securely. If exposed, anyone with the key can interact with your Clappia apps.
Avoid sharing the API key publicly.

Once a key is generated, a default usage limit is applied automatically:

Free Plan: 1000 API calls per month. This limit cannot be increased unless you upgrade to a paid plan.
Paid Plans: Also starts with 1000 API calls per month. You can increase the limit by purchasing add-ons.

Increasing API Request Limits

If you need a higher API request quota you will need to purchase more API calls:

Go to Workplace Settings > Billing tab.
Click on your current plan.
On the right panel, under Add-ons, click Add an Add-on.
Select REST API (1000 REST API calls per month) from the dropdown.
Choose the quantity (e.g., 1 = 1000 calls, 2 = 2000 calls).
Review other options to ensure no unnecessary add-ons are selected, then click Update and proceed with payment.

The pricing for each add-on will be visible during this process.

You can also monitor your current month's API usage directly from the Billings page.

‍Example Use Case: Submitting Employee Records

Here’s an example of how you can use the public APIs to push data into a Clappia app.

Scenario:
Let’s say you have an employee management app in Clappia and want to push new employee records from your internal HR system.

In the screenshots below, we are pushing data to an app named "Employee Master" through the REST Api. At the end you'll find the submission in the same Clappia app.

Steps

Generate the API Key in Workplace Settings following the steps above.
Get your workplace ID within Workplace Settings itself. When no option is selected, on the right panel, you will have general workplace information displayed.

Identify the App ID of your Clappia app. You can find this in the app URL after "app/".

Identify the unique field names of the app fields in your Clappia app where the data should be inserted.

API Request (POST):

The JSON payload can be used in tools like Postman for testing API requests or in custom scripts (e.g., Python, JavaScript) for automation. It’s typically used by your team’s developers or IT team when integrating external systems with Clappia.

{

"appId": "<your-app-id>",

"workplaceId": "<your-workplace-id>",

"requestingUserEmailAddress": "emailid@example.com",

"data": {

"employee_i": "EMP001",

"employee_n": "John Doe",

"address": "123 Main Street, City, Country",

"date_of_jo": "2024-01-15"

}

Add in your workplace api key where requested.

API Endpoint:

https://api-public-v3.clappia.com/submissions/create

When you send this request, the data will be pushed into the Clappia app as a new submission.

You will receive a confirmation, and Clappia will review your request.

‍

Bulk Upload Submissions

You can also create multiple submissions at once by uploading an Excel file through the Public API. This is useful when you need to create a large number of submissions from an external system.

First, upload the Excel file using the file upload API and get the fileId. Pass this fileId to the bulk upload submissions API to start creating submissions from the Excel file.

The bulk upload API returns an uploadId for the import. You can use this uploadId with the bulk upload status API to check the progress and status of the import.

The request must also include the email address or phone number of the user associated with the submissions. The API key identifies the workplace, so the requesting user must be specified separately in the request.

The bulk upload can handle a large number of rows, allowing external systems to create submissions in bulk instead of sending a separate API request for each submission.

Bulk Upload Status

Use the uploadId returned by the bulk upload submissions API to check the progress and status of the Excel import.

The status API provides the current status of the bulk upload and the result of the import, including cases where some submissions could not be created or the entire import fails.

‍

FAQs Section

What is an API key?
- An API key is a unique identifier used for authenticating API requests to your Clappia workplace.
What happens if I exceed the API request limit?
- You will receive a "Quota Exceeded" error, and further requests will be blocked until the next billing cycle or until your limit is increased.
Can I regenerate an API key?
- No, you cannot regenerate an API key.
How do I find the app ID for my app?
- Go to the app in Clappia and check the URL. The app ID will be part of the URL after "app/".

Explore all our APIs here - https://developer.clappia.com/

For any query on Clappia’s Public APIs, you can Raise a Support Request

API Category	API Subcategory	What it Does	Example
Submissions	(POST) Create Submissions	This API allows you to create new submissions in a Clappia App.	A logistics company can use this API to create new submissions for delivery status updates.
	(POST) Edit Submissions	This API allows you to update the values of an existing submission in a Clappia App.	An organization using a Clappia app to track customer visits can use this API to update customer visit details.
	(POST) Update Submission Status	This API is used to update the status of a submission in a specific Clappia app.	A manager reviewing a loan application in Clappia can use this API to update its status to "Approved".
	(POST) Update Submission Owners	This API allows you to update the owners of a specific submission in a Clappia app.	An operations manager reviewing a submitted site inspection report can use this API to assign the submission to the appropriate supervisor.
	(GET) Get Submission	This API allows you to retrieve the details of a specific submission from a Clappia App.	A business using Clappia to collect customer visit reports can use this API to retrieve the details of a specific visit.
	(POST) Get Submissions	This API allows you to retrieve multiple submissions from a Clappia App.	A customer support team logs all issue tickets in a Clappia app and can use this API to retrieve the tickets.
	(POST) Get Submissions Aggregation	This API allows you to retrieve submissions from a Clappia App using filters, sorting, and pagination.	A customer support team can use this API to retrieve a specific set of support tickets from a Clappia app when reviewing tickets for a particular purpose.
	(POST) Get Submissions Aggregation - Summary	This API allows you to retrieve submission counts from a Clappia App for a summary chart.	A sales manager can use this API to get the number of leads in each category for a summary chart.
	(POST) Get Submissions Aggregation - Bar Chart	This API allows you to retrieve calculated values such as totals, averages, minimums, maximums, and counts from submissions in a Clappia App for a bar chart.	A sales manager can use this API to show total sales by region in a bar chart.
	(POST) Get Submissions Aggregation - Data Table	This API allows you to retrieve calculated values such as totals, averages, minimums, maximums, and counts from submissions in a Clappia App for a data table.	A quality manager can use this API to display inspection results such as average scores and total inspections in a data table.
	(POST) Get Submissions Excel	This API allows you to retrieve submissions from a Clappia App in Excel format.	An operations team can use this API to retrieve submission data from a Clappia app in Excel format for further analysis.
	(POST) Get Submissions Count	This API allows you to retrieve the number of submissions in a Clappia App.	A manager can use this API to retrieve the number of submissions in a Clappia app.
App Definition	(POST) Add Field	This API allows you to add a new field to an existing Clappia app.	A team lead updating a site audit app can use this API to add a new field, such as "Site location".
	(POST) Update Field	This API allows you to update an existing field in a Clappia app.	A warehouse manager can use this API to rename a field from "Item Description" to "Product Details".
	(POST) Add Section	This API allows you to add a new section to a Clappia App.	A team managing an employee onboarding app can use this API to add a new section for employee documents.
	(POST) Update Section	This API allows you to update an existing section in a Clappia App.	An administrator can use this API to update an existing section in an employee onboarding app.
	(POST) Reorder Field	This API allows you to move a field to a different position in a Clappia App.	A team updating a site audit app can use this API to change the order in which fields appear in the app.
	(POST) Reorder Section	This API allows you to change the order of sections in a Clappia App.	An administrator can use this API to change the order of sections in a Clappia app.
	(POST) Add Page Break	This API allows you to add a page break after a section in a Clappia App.	A team designing a multi-page inspection app can use this API to add a page break between sections of the app.
	(GET) Get App Versions	This API allows you to retrieve the versions of a Clappia App.	An administrator can use this API to retrieve the versions of a Clappia app.
	(POST) Create App Version	This API allows you to create a new version of a Clappia App.	A team managing app changes can use this API to create a new version of a Clappia app.
	(POST) Update Live App Version	This API allows you to update the live version of a Clappia App.	An administrator can use this API to update the live version of a Clappia app.
	(POST) Update App Version	This API allows you to update a version of a Clappia App.	A team managing an app can use this API to update a specific version of the app.
	(POST) Update App Metadata	This API allows you to update the metadata and settings of a Clappia App.	An administrator can use this API to update metadata associated with a Clappia app.
	(POST) Update Page Break	This API allows you to update the properties of an existing page break, including its title, description, navigation settings, and button text.	A team managing an inspection app can use this API to update an existing page break.
	(GET) Get App Definition	This API allows you to retrieve the complete definition of a Clappia App, including its sections, fields, pages, and configuration details.	A developer can use this API to retrieve the definition of a Clappia app when integrating it with an external system.
Workplace User Management	(POST) Add User to Workplace - with email	This API allows you to add a new user to a specific Clappia Workplace using their email address.	An organization maintaining an MIS system for employees can use this API to automatically add employee records to a Clappia Workplace.
	(POST) Add User to Workplace - with phone	This API allows you to add a user to a Clappia Workplace using their phone number.	An organization can use this API to add employees to a Clappia Workplace using their phone numbers.
	(POST) Add User to Workplace - with email and phone	This API allows you to add a user to a Clappia Workplace using their email address and phone number.	An organization can use this API to add employees to a Clappia Workplace using both their email address and phone number.
	(POST) Add User to Workplace - assign attributes	This API allows you to add a user to a Clappia Workplace and assign attributes to them.	An HR team can use this API to add an employee to a Clappia Workplace and assign the required user attributes.
	(POST) Add User to Workplace - assign groups	This API allows you to add a user to a Clappia Workplace and assign them to groups.	An administrator can use this API to add an employee to a Clappia Workplace and assign them to the required user groups.
	(POST) Update Workplace User Details - with email	This API allows you to update a user's details in a Clappia Workplace using their email address.	An HR system can use this API to update the details of a Workplace user identified by their email address.
	(POST) Update Workplace User Details - with phone	This API allows you to update a user's details in a Clappia Workplace using their phone number.	An HR system can use this API to update the details of a Workplace user identified by their phone number.
	(POST) Update Workplace User Attributes - with email	This API allows you to update a user's attributes in a Clappia Workplace using their email address.	An HR team can use this API to update the attributes of an employee in Clappia using their email address.
	(POST) Update Workplace User Attributes - with phone	This API allows you to update a user's attributes in a Clappia Workplace using their phone number.	An HR team can use this API to update the attributes of an employee in Clappia using their phone number.
	(POST) Update Workplace User role - with email	This API allows you to update a user's role in a Clappia Workplace using their email address.	An administrator can use this API to update the role of a Workplace user identified by their email address.
	(POST) Update Workplace User role - with phone	This API allows you to update a user's role in a Clappia Workplace using their phone number.	An administrator can use this API to update the role of a Workplace user identified by their phone number.
	(POST) Update Workplace User Groups - with email	This API allows you to update the groups assigned to a user in a Clappia Workplace using their email address.	An administrator can use this API to update the groups assigned to a Workplace user using their email address.
	(POST) Update Workplace User Groups - with phone	This API allows you to update the groups assigned to a user in a Clappia Workplace using their phone number.	An administrator can use this API to update the groups assigned to a Workplace user using their phone number.
	(POST) Add User to App - using email	This API allows you to assign a user to a specific app within a Clappia Workplace using their email address and set their app permissions.	A team managing internal apps for different departments can use this API to give an employee access to a specific app.
	(POST) Add User to App - using phone	This API allows you to assign a user to a specific app within a Clappia Workplace using their phone number and set their app permissions.	A team can use this API to give a user access to a specific Clappia app using their phone number.
	(GET) Get Workplace Apps	This API fetches a list of all active apps present in a specific Clappia Workplace.	If an admin wants to regularly audit or sync the list of active apps, they can use this API to retrieve the app list.
	(POST) Get Workplace Users - Basic Request	This API allows you to retrieve users from a Clappia Workplace.	An HR or admin team managing a large organization on Clappia can use this API to fetch Workplace users.
	(POST) Get Workplace Users - With Pagination Token	This API allows you to retrieve users from a Clappia Workplace using a pagination token.	An HR or admin team managing a large organization can use this API to retrieve Workplace users across multiple pages of results.
	(GET) Get User Apps - with email	This API allows you to retrieve a list of apps assigned to a specific user using their email address.	If you assign different apps to different employees, you can use this API to retrieve the apps assigned to an employee using their email address.
	(GET) Get User Apps - with phone	This API allows you to retrieve a list of apps assigned to a specific user using their phone number.	If you assign different apps to different employees, you can use this API to retrieve the apps assigned to an employee using their phone number.
Workflows Definition	(POST) Add Workflow Step	This API allows you to add a new workflow step to a Clappia App.	A team managing an automated approval process can use this API to add a new workflow step to a Clappia app.
	(POST) Update Workflow Step	This API allows you to update an existing workflow step in a Clappia App.	An administrator can use this API to update an existing workflow step in a Clappia app.
	(POST) Reorder Workflow Step	This API allows you to change the order of workflow steps in a Clappia App.	A team can use this API to change the order of workflow steps in an automated process.
	(GET) Get App Workflow	This API allows you to retrieve the workflow configured for a Clappia App.	A developer can use this API to retrieve the workflow definition of a Clappia app when integrating it with an external system.
Charts Definition	(POST) Add Chart	This API allows you to add a new chart to a Clappia App.	A team managing a reporting app can use this API to add a new chart to a Clappia app.
	(POST) Update Chart	This API allows you to update an existing chart in a Clappia App.	A team can use this API to update an existing chart in a Clappia app.
	(POST) Reorder Chart	This API allows you to change the order of charts in a Clappia App.	An administrator can use this API to change the order of charts in a Clappia app.
	(GET) Get Charts	This API allows you to retrieve the charts configured for a Clappia App.	A developer can use this API to retrieve the charts configured in a Clappia app.
File Management	(POST) Generate File Upload URL	This API allows you to generate a URL to upload a file to Clappia storage.	An external system can use this API to generate a URL for uploading a file to Clappia.
	(PUT) Upload File to the Pre-signed PUT URL	This API allows you to upload a file using the generated pre-signed URL.	An external system can use this API to upload a file using the pre-signed URL generated by Clappia.
	(POST) Generate File Download URL	This API allows you to generate a URL to download a file from Clappia.	An external system can use this API to generate a URL for downloading a file stored in Clappia.
Bulk Upload	(POST) Import Bulk Upload Excel	This API allows you to create multiple submissions in a Clappia App by importing data from an Excel file.	A business that has a large number of records in an Excel file can upload the file and use this API to create multiple submissions in a Clappia app in one bulk upload.
	(POST) Get Bulk Upload Status	This API allows you to check the status of an Excel bulk upload in a Clappia App.	An operations team importing a large Excel file can use this API to check whether the bulk upload is still processing, has completed, or has failed.

Help

/

/

Deep Dive

/

Clappia Public APIs Documentation

Clappia Public APIs Documentation

Generating an API Key for Your Workplace

Steps to Generate an API Key

Increasing API Request Limits

‍Example Use Case: Submitting Employee Records

Bulk Upload Submissions

Bulk Upload Status