Migrating from v0 to v1

We recently introduced versioning to our API, and all requests moving forward should be made to endpoints prefixed with /v1. A list of breaking changes for the /v1 endpoints are listed below.
If you have any questions about migrating an existing integration from the v0 to the v1 API, don't hesitate to open an issue or contact support.

Breaking Changes

New Default Format

​Flat JSON (?format=flat)is now the default format returned from all text or component endpoints.
{
"[TEXT ID]": "[TEXT OF TEXT ITEM]",
"[TEXT ID]": "[TEXT OF TEXT ITEM]",
// Text items with plural values will have those plural
// values included in the output as individual key/value pairs
"[TEXT ID]_[PLURAL FORM]": "[TEXT OF PLURAL FORM]",
...
}
In v0, the default format was Full JSON, which is now deprecated
If you rely on text metadata like tags or statuses in development, try the Structured JSON (?format=structured)format instead; if that still doesn't suit your needs, please reach out to tell us about your use-case.

Change in behavior for fetch-projects​

/projects now returns a list of project names and ids instead of returning text data for the projects specified via query string parameter.
[
{
"id": "xxx-xxx",
"name": "Project Name",
"url": "https://app.dittowords.com/doc/xxx-xxx"
}
]
This is the same behavior that existed at /project-names in v0, with the only exception that this endpoint no longer includes an entry in the response representing the component library.

Removal of Fetch project names​

/project-names has been removed in favor of /projects.