Experience level
This core reference entry is suited for advanced-level builders.
You can find the API endpoint for your application in Settings - API.
An API endpoint is a specific URL or address where an API (Application Programming Interface) receives requests.
Article series: Introduction to APIs
Data API Root URL
The root URL of your application is structured as follows:
https://appname.bubbleapps.io/api/1.1/obj/typename
or if you have registered a domain:
https://yourdomain.com/api/1.1/obj/typename
Where the following variables are replaced to construct the final endpoint:
Variable | Content | Comment |
appname | the name of your application | If you have not registered a domain |
yourdomain.com | The domain of your application | If you have registered a domain |
typename | the name of the data type you are accessing | Use the data type name, but in lowercase and with spaces removed. |
App branches and Data API URL
The different branches of your app will have different URLs.
Development
Development will have the ID of the selected branch you are working on included. The ID of the Main branch is always version-test, while custom branches have their own unique IDs.
The URL in Settings - API will show the root URL including the branch ID in the branch you are currently working.
https://appname.bubbleapps.io/version-test/api/1.1/obj/typename
or
https://yourdomain.com/version-test/api/1.1/obj/typename
Live
https://yourdomain.com/api/1.1/obj/typename
or
https://appname.bubbleapps.io/api/1.1/obj/typename
The typename
The typename in the URL represents the data type you want to interact with. We highly recommend that you give all your data types a unique name, especially if you are using the Data API. If two data types share the same name, the Data API will return the first one it finds.
The typename is converted to a URL friendly format by removing spaces and setting it to lowercase. For example:
Data Type name: Rental Unit
Typename: rentalunit
Endpoint URL: https://appname.bubbleapps.io/api/1.1/obj/rentalunit
You can read more about the formatting of type names in this article.