API Reference
The ActivityInfo API allows you to query and update public and private ActivityInfo databases. You can also push updates to ActivityInfo databases for which you have write permissions.
ActivityInfo offers a JSON-based API that mostly follows RESTful principles, so you can either use your favorite REST client library to send and receive JSON, or you can use a client library for R for convenience.
Note that our web-based client and mobile apps are also built on this API. That means that anything that can be done through the user interface can be automated through the API.
Contents
Tutorials
Guided, learning-oriented lesson designed to lead you through a series of steps to accomplish a specific task, fostering understanding of features in ActivityInfo.
How-tos
Goal-oriented set of instructions, providing step-by-step directions to address specific real-world problems, designed for users with some prior experience
Explanations
Explanations serve to clarify and shed light on specific topics, contributing to a deeper understanding.
Reference
Precise technical descriptions focusing on providing exhaustive information on key elements.
Accounts
Billing accounts
-
Get billing account domains
-
Get billing account idps
-
Update account branding
-
Update account domain
-
Update billing account idp secret
-
Get billing account users
-
Get billing account databases
-
Add billing account idp
-
Get billing account
-
Get billing account branding
-
Delete billing account idp
-
Get deleted billing account databases
-
Get sub accounts
Database users
-
Add database user
-
Get database users
-
Delete database user
-
Unlock database user
-
Restore user
-
Get database user grants
-
Update database user grants
-
Update database user role
Databases
-
Add form
-
Add database
-
Get database tree
-
Get translations
-
Get databases
-
Revert database update
-
Duplicate form
-
Get original database tree
-
Get database user grants on resource
-
Update database
-
Audit database
-
Get database problems
-
Delete database
-
Get database billing account
-
Update database translations
Form displays
Forms
-
Get record
-
Relocate form
-
Recover form field
-
Get attachment
-
Upload attachment
-
Get form records
-
Get form schema diff
-
Get form schema
-
Get form geo json
-
Get record history
-
Get form schema version
-
Update form schema
-
Get attachment status
-
Update form schema translations
-
Recover deleted record
Icons
Jobs
-
Start job
-
Get job status
-
Duplicate scan
-
Convert subform to form
-
Export database forms
-
Export report
-
Export all users
-
Export attachments
-
Export billing account stats
-
Export form
-
Get job file
-
Export audit log
-
Duplicate database
-
Import xls form
-
Translate
-
Import records
-
Merge records
-
Export users
-
Recover database