ByteForms API Documentation

This is the complete API documentation for connecting to the ByteForms API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet ByteForms: Create forms, collect responses, manage workspaces, and analyze submissions in ByteForms. Keep reading to get started.

Quickstart

Before you run your first ByteForms request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one ByteForms connection — create or choose one in Connections. Note its connectionId.

Every ByteForms action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/byteForms/actions/{actionSlug}/run

You need a MindCloud API Key and a ByteForms connection. Then call an action such as Get Current User:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/byteForms/actions/get-current-user/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your ByteForms account. See ByteForms API Authentication for the full flow and how to get your connection credentials.

ByteForms actions

All 25 published actions for this ByteForms version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Workspace
• DELETEDelete Form
• DELETEDelete Response
• DELETEDelete Workspace
• GETExport Responses CSV
• GETExport Responses XLSX
• GETGet Active Subscription
• GETGet Current User
• GETGet Form
• GETGet Form Analytics
• GETGet Form Responses
• GETGet Invited Members
• GETGet Public Form
• GETGet Response
• GETGet Subscription Limits
• GETGet Workspace
• GETGet Workspace Members
• GETList Forms
• GETList Plans
• GETList Subscriptions
• GETList Workspace Invites
• GETList Workspaces
• PUTUpdate Current User
• PUTUpdate Form
• PUTUpdate Workspace

Related apps

More Productivity apps on the Universal API, behind the same REST shape. Or browse all apps.

Google CalendarNotionTypeformJira Software CloudCal.comWufooBasecampOnceHub