Skip to content

docs: add code examples to migrating_api article#540

Open
noliveleger wants to merge 2 commits into
masterfrom
migrating_api_update
Open

docs: add code examples to migrating_api article#540
noliveleger wants to merge 2 commits into
masterfrom
migrating_api_update

Conversation

@noliveleger
Copy link
Copy Markdown

@noliveleger noliveleger commented May 19, 2026

Summary

  • Added an Authentication section explaining the Authorization: Token xxxx header with curl, Python (requests), and R (httr) examples
  • Added code examples (curl / Python / R) to every endpoint section: project list, submission data, form details, tags, permissions, metadata, and user profile
  • Restructured each section with #### Code examples before #### Response examples for faster scanning
  • Wrapped response examples in <details> blocks to reduce visual noise
  • Fixed a Markdown rendering bug in the Form endpoints field mapping table (missing blank line before table)
  • Updated Last updated date to 19 May 2026 (commit ID still need to be changed)
  • Applied all changes to the French, Spanish, and Arabic locales

@noliveleger noliveleger requested a review from salomegarnier May 19, 2026 09:49
@noliveleger noliveleger self-assigned this May 19, 2026
@noliveleger noliveleger added the documentation Improvements or additions to documentation label May 19, 2026
Comment thread source/migrating_api.md


As part of our ongoing efforts to streamline and modernize the KoboToolbox platform, we are phasing out KPI and KoboCAT `v1` endpoints. All KPI and KoboCAT `v1` endpoints are now deprecated, and will be removed entirely in June 2026. `v1` endpoints are being phased out in favor of the more robust and fully supported KPI `v2` API.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The stated purpose of this article is explaining "how to migrate your API integrations", but we lack any way to educate the readership (which is large because we published an in-app message linking here) as to whether this information applies to them at all.

Perhaps we should include a section to help people, even extremely non-technical people who will have clicked an important-looking link and ended up here, understand if they will actually be affected in any way.

We should further guide people to our articles about using synchronous exports to connect to common platforms, such as:

Integrations using synchronous exports will NOT need any modification; they are totally fine as-is!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants