# Collections API

*Skill Level: Intermediate*

## Before You Begin

* The Adalo API is available on the Team and Business Plan.

This help article will show you how to access the documentation for your use. We will add additional resources in the near future for how and why you can use the Adalo Collections API. 

Step 1: Open your Adalo application and click on the three buttons beside the collection name.

![](https://3467607506-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LhGHkPsv15svPIU5I7C%2F-MJ9IEplViW7UMRwA-BO%2F-MJ9NVhPsx-bezEsr0g0%2FAdalo_CollectionsAPI_1.png?alt=media\&token=89c904e7-869f-478b-8996-829051b4ddaf)

Step 2: Then select API Documentation

![](https://3467607506-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LhGHkPsv15svPIU5I7C%2F-MJ9IEplViW7UMRwA-BO%2F-MJ9Nqi3BPlpyCr1h3eA%2FAdalo_CollectionsAPI_2.png?alt=media\&token=d371676a-1c1d-415f-9480-6932e6e7eb11)

Step 3: This will open a new tab with the Adalo Collections API Documentation. This data dynamically updates per individual applications.

![](https://3467607506-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LhGHkPsv15svPIU5I7C%2F-MJ9IEplViW7UMRwA-BO%2F-MJ9O2zR19wIfagT14u7%2FAdalo_CollectionsAPI_3.png?alt=media\&token=ec0fc464-52d7-45b6-b8c1-b10ca0e0bb93)

Step 4: \
Left side will show each of your collections and their respective endpoints.\
\
Center will show you the Headers required along with your already populated Adalo API Key. This key can also be generated from the Builder on the left nav > Settings > App Access > API Key.\
\
Right will show you the URL per endpoint and the data which is collected.

You can also access the Adalo Collections API Documentation by clicking on the records number shown by the collection.

![](https://3467607506-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LhGHkPsv15svPIU5I7C%2F-MJ9IEplViW7UMRwA-BO%2F-MJ9OqtdQXbl8eCcxLwh%2FAdalo_CollectionsAPI_4.png?alt=media\&token=5819f566-fb60-4d68-b245-5a6cc74b9bb1)

Then select the < > symbol in the top right to open the API Documentation.

![](https://3467607506-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LhGHkPsv15svPIU5I7C%2F-MJ9IEplViW7UMRwA-BO%2F-MJ9P81G68P24Lwod1J-%2FAdalo_CollectionsAPI_5.png?alt=media\&token=2090f7f4-d76e-4531-904e-a9a7a57678a5)

### Filtering with Query Parameters

Adalo’s Collections API supports filtering records via **query parameters** (`filterKey`, `filterValue`), but **only** on single-value properties (Number, Text, Boolean, Date). Relationship fields return **arrays** of IDs, so they **cannot** be filtered this way.

> **Example**: If your Items collection has a **Category** relationship, each Item’s Category value comes through as an array (e.g. `[36]`). Query params cannot match against arrays, so adding `?filterKey=Category&filterValue=36` will never return results.

**To use `filterKey` / `filterValue` successfully:**

1. Add a Number property (e.g. `CategoryID`) to your **Items** collection that holds the single ID of its Category.
2. Populate that field for each record (e.g. `CategoryID = 36`).
3. Call the API endpoint with:

   ```
   GET /collections/{ItemsCollectionId}/records
       ?filterKey=CategoryID
       &filterValue=36
   ```

   This will return only the items whose `CategoryID` equals `36`.

***