You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/api.md
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,7 @@ Using the KoboToolbox API allows you to automate routine tasks, keep dashboards
18
18
- Retrieving your **API Key**
19
19
- Retrieving the project asset UID
20
20
- Exporting your data using the API
21
-
22
-
<pclass="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
25
22
26
23
## Retrieving your server URL
27
24
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
78
75
<br><br>
79
76
To learn more about connecting your data to Microsoft Excel, see <ahref="https://support.kobotoolbox.org/pulling_data_into_excelquery.html">Connecting KoboToolbox to Microsoft Excel</a>.
80
77
</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.
| 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
+
<pclass="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