# 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.

{% hint style="info" %} <mark style="color:red;">Please note</mark>: 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.
{% endhint %}

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:

* [Row Metadata and Relationships](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/row-metadata-and-relationships.md) - system metadata, `embeddingRowID`, linked-table structures, and canonical row semantics
* [microappdata](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/microappdata.md) - read many rows with filtering, sorting, and child-row queries
* [microappdata/row](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/microappdata-row.md) - read one row by `rowID`
* [Common API Examples](/rest-api/buzzy-rest-api/rest-api/common-api-examples.md) - login/logout, token handling, CRUD, metadata-aware flows, and `embeddingRowID` examples across all API styles

***

### Table of contents

## Authentication

* [login](/rest-api/buzzy-rest-api/rest-api/login.md) - Authenticate and get access token
* [logout](/rest-api/buzzy-rest-api/rest-api/logout.md) - Log out and invalidate access token
* [sendnotification](/rest-api/buzzy-rest-api/rest-api/sendnotification.md) - Send direct app notifications to a user by email

## AI-Powered Features

* [createappwithprompt](/rest-api/buzzy-rest-api/rest-api/createappwithprompt.md) - Create apps using AI prompts

## File Operations

* [s3copy](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/s3copy.md) - Copy files between S3 locations
* [uploadFileToS3](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/uploadfiletos3.md) - Upload files to S3 from URLs

### MicroApp Data Operations

* [row metadata and relationships](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/row-metadata-and-relationships.md) - Canonical system fields, `embeddingRowID`, and linked-table semantics
* [microappdata](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/microappdata.md)
* [microappdata/row](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/microappdata-row.md)
* [insertmicroapprow](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/insertmicroapprow.md)
* [updatemicroapprow](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/updatemicroapprow.md)
* [removemicroapprow](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/removemicroapprow.md)
* [microappchild](/rest-api/buzzy-rest-api/rest-api/microapp-data-operations/microappchild.md) - Child resources (files/images) for MicroApp data entries

### Common Examples

* [Common API Examples](/rest-api/buzzy-rest-api/rest-api/common-api-examples.md) - Unified CRUD examples across all three API approaches

### User & Organization Operations

* [userid](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/userid.md) - Get user ID from email address
* [insertteammembers](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/insertteammembers.md) - Add members to a team
* [teammembers](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/teammembers.md) - Get team members
* [insertorganization](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/insertorganization.md) - Create a new organization
* [readorganization](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/readorganization.md) - Read an organization
* [updateorganization](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/updateorganization.md) - Update an organization
* [deleteorganization](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/deleteorganization.md) - Delete an organization
* [insertteam](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/insertteam.md) - Create a new team
* [readteam](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/readteam.md) - Read a team
* [updateteam](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/updateteam.md) - Update a team
* [deleteteam](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/deleteteam.md) - Delete a team
* [readteammember](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/readteammember.md) - Read a team member
* [updateteammember](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/updateteammember.md) - Update a team member
* [deleteteammember](/rest-api/buzzy-rest-api/rest-api/user-and-organization-operations/deleteteammember.md) - Remove a team member

***


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.buzzy.buzz/rest-api/buzzy-rest-api/rest-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.