Jump to Content
API Reference
Changelog
v2.0
v2025.0
API Reference
v2.0
API Reference
Field Types
All
Pages
Start typing to search…
JUMP TO
REST API
Overview
Authorization
/oauth2/authorize
get
/oauth2/token
post
Resources
Forms
/form
get
/form
post
/form/:id
get
/form/:id
put
/form/:id
del
/form/:id/copy
post
/form/:id/basic
get
/form/:id/html
get
Fields
Field Types
/form/:id/field
get
/form/:id/field
post
/field/:id
get
/field/:id
put
/field/:id
del
Folders
/folder
get
/folder
post
/folder/:id
get
/folder/:id
put
/folder/:id
del
Submissions
/submission
get
/form/:id/submission
get
/form/:id/submission
post
/submission/:id
get
/submission/:id
put
/submission/:id
del
/form/:id/count
get
/download/:submission_id/:field_id/:index
get
Partial Submissions
/form/:id/partialsubmission
get
/partialsubmission/:id
get
/partialsubmission/:id
del
Confirmation Emails
/form/:id/confirmation
get
/form/:id/confirmation
post
/confirmation/:id
get
/confirmation/:id
put
/confirmation/:id
del
Notification Emails
/form/:id/notification
get
/form/:id/notification
post
/notification/:id
get
/notification/:id
put
/notification/:id
del
Webhooks
/form/:id/webhook
get
/form/:id/webhook
post
/webhook/:id
get
/webhook/:id
put
/webhook/:id
del
Field Logic
Field Calculations
Portals
/portal
get
/portal/:id
get
/portal/:id
put
/portal/:id
del
/portal/:id/copy
post
/portal/:id/avatar
post
/portal/:id/avatar
del
/portal/:id/user
post
/portal/:id/user
del
/portal/:id/user
put
/portal/:id/form
post
/portal/:id/form/:portalFormId
put
/portal/:id/form/:portalFormId
del
Smart Lists
/smartlist
get
/smartlist
post
/smartlist/:id
get
/smartlist/:id
put
/smartlist/:id
del
/smartlist/:id/option
get
/smartlist/:id/option
post
/smartlist/:id/option/:optionId
get
/smartlist/:id/option/:optionId
put
/smartlist/:id/option/:optionId
del
/smartlist/:id/option/:optionId/image
del
/smartlist/:id/option/:optionId/image
post
/smartlist/:id/alloptions
del
/smartlist/:id/bulkoptions
post
Subaccounts
/subaccount
get
/subaccount/:subaccount_id/theme/:theme_id/copy
post
/subaccount/:subaccount_id/form/:form_id/copy
post
Getting Started With Your API
SCIM
Overview
Authentication
Models Reference
Users
/Users
get
/Users
post
/Users/:id
get
/Users/:id
put
/Users/:id
patch
/Users/:id
del
Groups
/Groups
get
/Groups
post
/Groups/:id
get
/Groups/:id
put
/Groups/:id
patch
/Groups/:id
del
Forms
/Forms
get
/Forms/:id
get
Folders
/Folders
get
/Folders/:id
get
SCIM API
Getting Started With Your API
User Management API
Audit Logs
Stream audit logs as CSV
get
Users
Get current user details
get
Update current user
put
List current account users
get
Create user
post
Remove user
del
Get user details
get
Update user
put
Resend invitation email
post
Notification Preferences
Current user notification preferences
get
Update current user notification preferences
patch
Oauth Consent Sessions
Revoke OAuth consent session
del
List OAuth consent sessions
get
Groups
List current account groups
get
Create group
post
Remove group
del
Get group details
get
Update group
put
List group project memberships
get
In App Messages
List current account app messages
get
Update in app message
put
Project Memberships
Update project membership
put
Add users and/or groups to project
put
Get the project membership groups
get
Remove users and/or groups from project
put
Get the project membership users
get
Rss
Get the latest RSS item
get
User Groups
List user groups
get
Update user groups
put
Workflows
Logic Rules
Create logic rule
post
Get logic rule operators
get
Delete logic rule
del
Get logic rule
get
Create rule condition
post
Update logic rule
patch
Projects
Get projects list
get
Create project
post
Delete project
del
Get project by UUID
get
Update project
patch
Unstar a project
del
Star a project
post
Get workflow by project UUID
get
Steps
Create workflow step
post
Get step types list
get
Delete step
del
Get step by UUID
get
Update step
patch
Automap step
post
Get step datasets available for step
get
Get list of dataset entities
get
Get step logic rules
get
Get step mappable fields
get
Steps/mapping
Delete all step mappings(both from and to the step)
del
Get step mapping
get
Create step mapping
post
Create step mappings
post
Delete step mappings
post
Get amount of mappings created from the step
get
Delete step mapping
del
Get step mapping by ID
get
Update a field mapping by ID
patch
Delete step mapping metadata
del
Steps/metadata
Get step metadata
get
Update multiple step metadata fields
patch
Delete step metadata
del
Workflows
Get workflows by UUID
get
Create workflow
post
Delete workflow
del
Get workflow by UUID
get
Update workflow
patch
Get workflow edges
get
Get workflow steps
get
Data Catalog
Data Class
List all data classes
get
List all data classes
get
Entity
List all data fields
get
Look up fields for each entity ID.
post
Get a list of entities
get
Look up multiple entities at once.
post
Get a list of entities
get
Get data fields on an entity
get
Create data field on entity
post
Get a singular field on an entity
get
Update data field on entity
put
Update data class id on field
put
Update Metadata on field
post
Run schema drift detection
post
Data Activation
Dataset
Retrieves a list of data sets associated with an organization.
get
Creates a new data set.
post
Find datasets grouped by entity ID.
post
Deletes a data set
del
Gets a data set by ID
get
Partially updates a data set (label and descriptor only)
patch
Updates a data set
put
Entity Graph
List entity graph IDs
get
Get entity graph
get
Get Graph Link By Id
get
Get adjacent node on graph entity graph
get
Powered by
Field Types
Ask AI
Below is a list of Formstack field types that you can use with the API
