Create your first API Endpoint

Build a secure API Endpoint that validates input and updates your data.

Set up the API Endpoint

1. Go to Data & API > Backend Workflows > API Endpoints
2. Click + Add API
3. Choose whether to Build from scratch or start from a template
4. If you use a template, pick the one closest to your use case and rename it if needed
5. Give it a Name
6. Set the Path (e.g., update)
7. Keep the trigger as On API request
8. Configure security in the Security panel — Set the access level (Public or Authenticated), optionally limit by roles, and optionally add middleware workflows for more control

Define inputs

• In the Parameters panel, add inputs for fields you expect (e.g., id, client_name, email)
• Database‑linked inputs appear automatically when you select table actions
• Mark required inputs and set defaults where relevant

If you started from a template, review the inputs before testing.

Add actions

• Add a Tables | Update data or Tables | Insert data action and choose your table
• Map inputs to columns or use a Table Link input to auto‑map
• Optionally chain more actions (e.g., call a third‑party API, log activity)

CRUD modes and filters

Table actions support two selection modes:

• By ID — Provide the record id
• By Filters — Build conditions similar to views; you can also bind parameters

Examples:

Tables | Get data

• By ID — Return a single row by its primary key
• By Filters — Return rows that match your conditions (optionally set limit/sort)

Tables | Update data

• By ID — Update a specific row
• By Filters — Update all rows that match the filter (use cautiously)

Tables | Delete data

• By ID — Delete a specific row
• By Filters — Delete all rows that match the filter (use cautiously)

Return a response

• Use the Send response action to return data (like the updated record)
• Use the Try/Catch action to handle errors and return error messages with appropriate status codes

Test and deploy

• Use the Test button to run with sample inputs
• Click Deploy to publish this version
• Use Revert changes to roll back to the previously deployed version

CONTINUE LEARNING

Call your API Endpoint safely from your app.

Call from interface workflows →