Ditto
Search
K

Ditto API v0 (deprecated)

Programmatically read and write data in your Ditto workspace.
You probably want the v1 endpoints page. This is the documentation for the v0 API, which has been deprecated. If you're an existing API user, please reference this page for a list of breaking changes and instructions for migrating.

Projects

get
https://api.dittowords.com
/project-names
Fetch project names
get
https://api.dittowords.com
/projects
Fetch projects
get
https://api.dittowords.com
/projects/:id
Fetch project by ID
get
https://api.dittowords.com
/projects/:id/components
Fetch components by project

Components

get
https://api.dittowords.com
/components
Fetch components
put
https://api.dittowords.com
/components
Update components

Component Folders

get
https://api.dittowords.com
/component-folders
Fetch component folders
get
https://api.dittowords.com
/component-folders/:api_id/components
Fetch components by component folder

Variables

get
https://api.dittowords.com
/variables
Fetch variables

Variants

get
https://api.dittowords.com
/variants
Fetch variants

Additional Data Structures

Update Component Data

The shape that the request body should conform to for the Update components endpoint.
{
"[API ID]": {
"text": "[TEXT OF TEXT ITEM (CAN INCLUDE VARIABLES)]",
"notes": "[NOTES OF TEXT ITEM]", // optional
"tags": [ ... ], // optional: array of strings
"plurals": [ // optional: array of plural objects
{
"text": "[TEXT OF PLURAL FORM]",
"form": "[one|two|zero|few|many|other]"
}
]
}
}