REST API

Use the REST data source when you want Budibase to connect to an external API.

REST setup has two parts:

• Connection settings in Workspace Settings > Connections > APIs
• Query settings in the API Editor

Create a REST connection

1. Open your workspace
2. Go to Workspace 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

Create a query

1. Open the API builder sidebar and click New API
2. Or open an existing connection and click Open in API Editor
3. Select or create the connection
4. Set the method and endpoint path
5. Add any required params, headers, body fields, or bindings
6. Select an auth config if needed
7. Click Send
8. Review the response and schema
9. Click Save Query

Common migration notes (old to new UI)

• Older docs 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