GET
/
textItems
Fetch text items
curl --request GET \
  --url https://api.dittowords.com/v2/textItems \
  --header 'Authorization: <api-key>'
[
  {
    "id": "text-item-dev-id",
    "text": "Base text",
    "status": "NONE",
    "notes": "base notes",
    "tags": [
      "baseTag1",
      "baseTag2"
    ],
    "variableIds": [],
    "projectId": "project-dev-id",
    "variantId": null,
    "richText": "<strong>Base</strong> text"
  },
  {
    "id": "text-item-dev-id",
    "text": "French text",
    "status": "WIP",
    "notes": "base notes",
    "tags": [
      "baseTag1",
      "baseTag2"
    ],
    "variableIds": [
      "age",
      "name"
    ],
    "projectId": "project-dev-id",
    "variantId": "french",
    "richText": "<em>French</em> text"
  },
  {
    "id": "another-text-item",
    "text": "Some base text",
    "status": "FINAL",
    "notes": "base notes",
    "tags": [
      "baseTag1",
      "baseTag2"
    ],
    "variableIds": [
      "age",
      "name"
    ],
    "projectId": "another-project",
    "variantId": null,
    "richText": "Some <strong>base</strong> text"
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
filter
string

Stringified JSON filter object. Can filter by projects (array of project IDs) and/or variants (array of variant IDs or 'all' or 'base'). Example: {"projects":[{"id":"project-id"}],"variants":[{"id":"french"}]}

​
richText
enum<string>

When set to 'html', includes HTML-formatted rich text in the response

Available options:
html

Response

200 - application/json

Returns an array of text items matching the filter criteria

​
id
string
required

The Developer ID of the text item

​
text
string
required

The plaintext content of the text item. May be base or variant text depending on variantId

​
status
string
required

The current status of the base or variant text

​
notes
string
required

The notes on the text item. Variants will have the base text item's notes value

​
tags
string[]
required

Array of tags associated with the text item. Variants will have the base text item's tags value

​
variableIds
string[]
required

Array of Developer IDs of variables used in this base or variant text

​
variantId
string | null
required

The developer ID of this variant, or null for base text

​
projectId
string

The developer ID of the project this text belongs to

​
richText
string

HTML-formatted version of the text content. Only included when richText=html query parameter is provided