> For the complete documentation index, see [llms.txt](https://manual.bubble.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.bubble.io/~/changes/oSsRRFoN6bhUP7nqCRaz/core-resources/api/the-bubble-api.md). # The Bubble API The Data API allows other systems to search for, read, create, modify and delete data in your application’s database via a RESTful interface. {% hint style="info" %} This is the short-form **technical reference** entry describing the Bubble API. If you are looking for more in-depth and long-form articles on how the Bubble API works, you may be interested in checking the [Bubble API manual](#manual-references). {% endhint %} ## Reference entries ### The Data API The Data API allows other systems to search for, read, create, modify and delete data in your application’s database via a RESTful interface. {% content-ref url="/pages/kU5he9ow8m53J7P1ws74" %} [The Data API](/~/changes/oSsRRFoN6bhUP7nqCRaz/core-resources/api/the-bubble-api/the-data-api.md) {% endcontent-ref %} ### The Workflow API The Workflow API allows external applications to execute workflows in your Bubble app via a RESTful interface. {% content-ref url="/pages/QT2BQ2gOa929o0uTqX6U" %} [The Workflow API](/~/changes/oSsRRFoN6bhUP7nqCRaz/core-resources/api/the-bubble-api/the-workflow-api.md) {% endcontent-ref %} ## Sending data Frequently, you want to send data/parameters with the calls. They can either be in the URL in a stringified, URL-encoded way, usually for GET, or in the body of the request, usually for POST. When you send data with a request, Bubble validates it and makes sure it has the correct format. Here are four particular cases:\ \ 1\) **Geographic addresses:** This data should be sent as a string '33 Nassau Avenue, Brooklyn, NY 11222,' and Bubble will use the Google Map API to encode it as an address with a latitude and longitude. You can also send them as an object.\ \ `{`\ `address: String`\ `lat: Number`\ `lng: Number`\ `}`\ \ where latitude and longitude **or** address is mandatory.\ \ 2\) **Dates:** Send a date as a string or timestamp. For example, 'Wed Jan 13 2016,' '01/13/2016,' 'Wed Jan 13 2016 16:45:09 GMT-0500 (EST),' or '1453398788637.'\ \ 3\) **Files and Images:** When a parameter is a file or image, you have two ways to define the content in the request. You can submit a string, which should be the URL of the file/image hosted on a storage service, or you can provide the raw data and the API call will upload the content to Bubble's hosting services. In the later case, the value provided should be a JSON object as follows:\ \ `{`\ `filename: String`\ `contents: Base64-encoded binary data`\ `private: Boolean`\ `attach_to: String`\ `}`\ \ where:\ – `filename` is the file name. Optional, but recommended to get the file type.\ – `contents` is the base64-encoded binary data of the file. Required.\ – `private` is a boolean, true/false, that defines whether the file is protected and attached to an object in the database. Optional.\ – `attach_to` is the unique ID of who/which thing owns the file. Required if private is true.\ \ If there is an ambiguity in processing the data sent, Bubble returns a 400 error, 'INVALID\_DATA.'\ \ 4\) **Things:** If a parameter is a thing, e.g., an entry in the application database, or a list of things, you can send it using the ID of the thing. When such a request is made, the API will retrieve the thing with that ID and validate the type. It should be the type defined at the parameter level for a workflow, for instance. If a thing isn't found or not of the right type, Bubble returns a 400 error, 'INVALID\_DATA'. ## Bubble API response Bubble's API generates data in the JSON format. If you use the Workflow API, the *Return data from API* action permits specification of the data returned by the call. You will find a more detailed description of API response in our [Data API request](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/the-data-api/data-api-requests.md) and [Returning data fro the workflow API request](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/the-workflow-api/api-workflows/creating-api-workflows.md#returning-data-from-the-api-workflow) articles. ### Returning a login token Using a *Sign up* or *Log the user in* action in your workflow generates a response that includes a user\_id, token, and expires value. These facilitate the authentication of ensuing calls as the user who has just registered or logged in. ### Success and error codes A 200 code, potentially accompanied by some data, signifies the success of calls, whereas unsuccessful calls produce an error code. ## Rate limiting Requests are rate-limited by default to 1,000 requests/minute per application, collectively between Live and Development. A rate-limited request will return an HTTP 429 error. ## API Versions A new version is introduced when a non backward compatible change is deployed. The current API version of 1.1 was introduced on January 19, 2017.\ \ – **Version 1.1:** Values are returned as Javascript objects when possible in API responses. In particular, dates are returned as `2016-11-11T19:14:46.517Z` instead of a timestamp, and geographic addresses are returned as a JSON object. Introduced on January 19, 2017.\ \ `location = {`\ `address: "Les Ferreys, 14130, France"`\ `lat: 49.19959`\ `lng: 0.19707`\ `}`\ \ – **Version 1.0:** The first release. Introduced in January 2016.\ \ You can send values for addresses either as an address string or object, which should be similar to the output format. When submitting, only lat/lng or an address is required. ## Manual references The Bubble manual gives extended information about Bubble's features and how to use them.
Introduction to APIs This article series takes an in-depth look at what exactly an API is and how you can both set up an API in Bubble and connect to external APIs in different ways. Article: [Introduction to APIs](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/introduction-to-apis.md)\ Video: [Introduction to APIs](https://www.youtube.com/watch?v=nO8PSqeJaWk\&t=745s)\ Article: [What is a RESTful API?](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/introduction-to-apis/what-is-a-restful-api.md)
Authenticating with the Bubble API Authentication is the process of identifying **who** the client is in order to determine what they have access to.\ \ Article series: [The Bubble API and authentication](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/authentication.md)\ \ \ **Authentication types**\ The Bubble API lets clients authenticate in different ways:\ \ Article: [Accessing the Bubble API without authentication](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/authentication/no-authentication.md)\ Article: [Accessing the Bubble API authenticated as a User](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/authentication/as-a-user.md)\ Article: [Accessing the Bubble API authenticated as an admin](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/authentication/as-an-admin.md)
**How to set up authentication in the external system**\ The Bubble uses the bearer token method to authenticate clients. Article: [How to set up authentication in an external app](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/authentication/how-to-authenticate.md)
The Data API The Data API lets you set up an API in your Bubble application that accepts **incoming** **requests** to search for, read, create, edit and delete entries in your database.\ \ Article series: [The Data API](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/the-data-api.md)
The Workflow API The Data API lets you set up an API in your Bubble application that accepts **incoming** **requests** to trigger workflows.\ \ Article series: [The Workflow API](/~/changes/oSsRRFoN6bhUP7nqCRaz/help-guides/integrations/api/the-bubble-api/the-workflow-api.md)