Skip to content

Commit 54bf585

Browse files
Add advanced API documentation section (#473)
Added advanced API documentation section with details on interactive interface and endpoints.
1 parent 23586ff commit 54bf585

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

source/api.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,7 @@ Using the KoboToolbox API allows you to automate routine tasks, keep dashboards
1818
- Retrieving your **API Key**
1919
- Retrieving the project asset UID
2020
- Exporting your data using the API
21-
22-
<p class="note">
23-
<strong>Note:</strong> V1 endpoints are now deprecated and scheduled for decommissioning in January 2026, in favor of the more robust and fully supported KPI v2 API. For more information on migrating to KPI v2, see <a href="https://support.kobotoolbox.org/migrating_api.html">Migrating from v1 to v2 API</a>.
24-
</p>
21+
- Advanced API documentation
2522

2623
## Retrieving your server URL
2724
The **server URL** is the base web address of your KoboToolbox server. It is placed at the start of every API request.
@@ -78,3 +75,22 @@ To learn more about connecting your data to Power BI to create custom dashboards
7875
<br><br>
7976
To learn more about connecting your data to Microsoft Excel, see <a href="https://support.kobotoolbox.org/pulling_data_into_excelquery.html">Connecting KoboToolbox to Microsoft Excel</a>.
8077
</p>
78+
79+
## Advanced documentation
80+
81+
The API documentation at `https://[server-url]/api/v2/docs/` provides an interactive interface for API endpoints. It replaces information previously presented in each endpoint.
82+
83+
| **KoboToolbox Server** | **API Documentation** |
84+
| :----------------- | :--------------------------------------------- |
85+
| Global KoboToolbox Server | https://kf.kobotoolbox.org/api/v2/docs/ |
86+
| European Union KoboToolbox Server | https://eu.kobotoolbox.org/api/v2/docs/ |
87+
88+
These advanced documentation pages list all endpoints, show allowed query parameters, include a search bar, display example responses, show example error responses, and allow direct testing of requests in your browser. Use this documentation for verifying authentication, discovering functions, and copying exact URLs into custom scripts.
89+
90+
You can also download the API documentation schema in YAML format at `https://[server-url]/api/v2/schema/` or in JSON format at `https://[server-url]/api/v2/schema/?format=json`.
91+
92+
<p class="note">
93+
<strong>Note:</strong> V1 endpoints are now deprecated and scheduled for decommissioning in January 2026, in favor of the more robust and fully supported KPI v2 API. For more information on migrating to KPI v2, see <a href="https://support.kobotoolbox.org/migrating_api.html">Migrating from v1 to v2 API</a>.
94+
</p>
95+
96+
For more examples of using the API, see this [Community Forum post](https://community.kobotoolbox.org/t/kobo-api-examples-using-new-kpi-endpoints/2742).

0 commit comments

Comments
 (0)