Set up an API GET request for list page
The Data Collections allows you to create API requests to any database or tool with an available REST API.
Here is how to create a GET request to retrieve data to be displayed in your apps.
If you are connecting to Airtable, you can use the Airtable API Wizard to automatically set up GET requests for you. Also, if you have an OpenAPI, Postman or Swager collection, you can import it via JSON file.
You can utilise other API verbs (i.e. POST) to retrieve data if your API specifies otherwise. Simply change the verb type of the request URL.
Use this request URL to get sample data for the example below.
1. In Data Collections, click
Create a new collectionand select
Start from scratch.
2. Enter the name of your collection and an optional description (we recommend putting the source as the description, like Google Sheet).
A Collection is a group of API requests, normally from the same data source.
3. You're ready to create requests! First, edit the request name to help you identify it.
4. Input the GET request URL from the API of your choosing. (Or use the example request we listed above)
5. If the API has Headers or Parameters values you need to input in order to send the request call, input them in the section below. (The example request does not require any extra input)
Often, if the API requires an API key, you need to input it under Headers or Authentication in the collection settings.
Authorization via bearer token is one of the most common authentication methods.
Send. You will receive a response list of all the data retrieved from the API request. You have successfully retrieved data from an API! 🎉
If you encounter any error message after clicking Send, you can consult the
Debugsection to get more information about the error.
In your response list under Received Data, you will see all the data items that the API request is sending over.
The text in light gray is the name of the data item. The text in green is text value of the data item, and text in pink is numerical value.
1. If you are selecting data that you want to populate into a list in your design, first select
Allwhere you see a dropdown option. This selects the array (list) of data rather than one data record. If you are not selecting a list of data, skip to Step #2.
2. Next, check the box next to all the data items that you want to bind to your app design. Any data you select here will appear as an option to bind in Data Binding.
3. Under Selected Data, it lists all the data items you have selected and automatically denotes the one(s) that is an array.
Path: the name of the data item sent from the API. We don't recommend editing this unless you know what you're doing.
Name: the name to easier identify the data item. It appears in Data Binding, and you may also edit this for certain request setups.
Sample Value: sample content of the data item. This sample content will also be the placeholder content for any fields that come up blank. You can delete it if you don't want to override any blank fields.