Endpoints

Programmatically read and write data in your Ditto workspace.

Base URL
https://api.dittowords.com/v1

Please ensure that your requests are using the `/v1` path prefix to avoid interacting with a deprecated version of the Ditto API.
Projects
Only projects that have developer mode enabled are accessible via the API.
get
https://api.dittowords.com/v1
/projects
Fetch projects
get
https://api.dittowords.com/v1
/projects/:id
Fetch text by project id
get
https://api.dittowords.com/v1
/projects/:id/components
Fetch component text by project id
Components
get
https://api.dittowords.com/v1
/components
Fetch component text
put
https://api.dittowords.com/v1
/components
Update component text variant
Update component text variant — Payload
The shape that the request body should conform to for the Update component text variant endpoint.
{
  "data": {
    "[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]"
        }
      ]
    }
  }
}
post
https://api.dittowords.com/v1
/components/file
Import components via a file
Component Folders
get
https://api.dittowords.com/v1
/component-folders
Fetch component folders
get
https://api.dittowords.com/v1
/component-folders/:api_id/components
Fetch component text by component folder
Variables
get
https://api.dittowords.com/v1
/variables
Fetch variables
Variants
get
https://api.dittowords.com
/variants
Fetch variants

Authentication

Text Formats

Last modified 1mo ago