REST API

The Buzzy REST APIs (which are a type of web API) involve requests and responses. You make a request to a resource stored on the server, and the server responds with the requested information. The protocol used to transport the data is HTTP(S). “REST” stands for Representational State Transfer.

The Buzzy API provides access to Apps and Datatables stored on the server. It allows you to create, insert, update and query data using a secure authenticated connection.

The endpoints are accessed using a POST method with a JSON document describing the input parameters.

REST API responses follow the same server-side row access, field access, and Private Data rules as the Buzzy runtime. Authenticate API integrations as the user or integration account whose permissions match the workflow. Do not assume an API caller receives raw values just because the endpoint can read a datatable.

Please note: Datatables were previously called Microapps, you will see references to "microAppID", "Microapp End-point", and functions like "insertmicroapprow" throughout this tutorial.

When in doubt - email support.

When using existing Datatable, get the “microAppID” by going to the Datatable properties, “General” tab. Copy that ID for posting to that specific Datatable. Similar when a “fieldID” is required, edit the field definition and scroll to the bottom to get the field identifier.

Time is kept as Epoch numeric values - eg in JavaScript “new Date().getTime()”.

Canonical Data Docs

For row semantics shared across REST, Async API, and the Node.js client, use the REST docs below as the source of truth:

• Endpoint Parameter Guide - required and optional parameters, caveats, and best practices for every REST endpoint

• Row Metadata and Relationships - system metadata, embeddingRowID, linked-table structures, and canonical row semantics

• microappdata - read many rows with filtering, sorting, and child-row queries

• microappdata/row - read one row by rowID

• microappchild - read and manage file/image child records, including Private Data attachment behavior

• Common API Examples - login/logout, token handling, CRUD, metadata-aware flows, and embeddingRowID examples across all API styles

---

Table of contents

• Endpoint Parameter Guide

Authentication

• login - Authenticate and get access token

• logout - Log out and invalidate access token

• sendnotification - Send direct app notifications to a user by email

AI-Powered Features

• createappwithprompt - Create apps using AI prompts

File Operations

• s3copy - Copy files between S3 locations

• uploadFileToS3 - Upload files to S3 from URLs

MicroApp Data Operations

• row metadata and relationships - Canonical system fields, embeddingRowID, and linked-table semantics

• microappdata

• microappdata/row

• insertmicroapprow

• updatemicroapprow

• removemicroapprow

• microappchild - Child resources (files/images) for MicroApp data entries

Common Examples

• Common API Examples - Unified CRUD examples across all three API approaches

User & Organization Operations

• userid - Get user ID from email address

• insertteammembers - Add members to a team

• teammembers - Get team members

• insertorganization - Create a new organization

• readorganization - Read an organization

• updateorganization - Update an organization

• deleteorganization - Delete an organization

• insertteam - Create a new team

• readteam - Read a team

• updateteam - Update a team

• deleteteam - Delete a team

• readteammember - Read a team member

• updateteammember - Update a team member

• deleteteammember - Remove a team member

---