REST API

Budibase REST integrations are configured from Workspace Settings > Connections > APIs.

A REST integration has two layers:

• Connection-level config in Settings (auth, base URL, shared headers/variables)
• Query-level config in API Editor (method, path, body, bindings, pagination, transformer)

Create a REST connection

1. Open your workspace
2. Go to Settings > Connections > APIs
3. Click Add connection
4. Choose either:
   • Create custom for direct/manual setup
   • A template for a pre-seeded setup
5. Enter a Display name
6. Open Credentials and set Base URL
7. Add any required shared headers/URL params/static variables
8. Click Save

Connection tabs reference

Open the API Editor and create your first query

1. Open the saved connection
2. Click Open in API Editor
3. Click Create new query
4. Set method and endpoint path
5. Add required params/headers/body
6. Pick auth config if needed
7. Click Send
8. Review response and schema
9. Click Save Query

Common migration notes (old to new UI)

• Older docs and workflows may reference APIs or datasources from legacy menus
• Current workflow for REST setup starts in Settings > Connections > APIs
• Query authoring still happens in the API Editor via Open in API Editor

Recommended reading order

1. REST Templates
2. REST queries
3. REST authentication
4. REST bindings (tutorial)
5. REST variables
6. REST query import
7. REST pagination
8. REST OAuth2
9. REST example