Skip to main content
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"
    ],
    "assignee": "john@example.com",
    "integrated": true,
    "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"
    ],
    "assignee": "john@example.com",
    "integrated": true,
    "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"
    ],
    "assignee": null,
    "integrated": false,
    "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. Supports the following filter fields:

  • projects: array of objects with id (project developer ID)
  • variants: array of objects with id (variant developer ID, base, or all)
  • statuses: array of status strings (NONE, WIP, REVIEW, FINAL)
  • tags: object with values (array of tag strings) and optional operator (AND or OR, defaults to OR)
  • assignee: email string to match assigned text items, or null for unassigned
  • integrated: boolean value to filter by items that are or are not integrated into development

By default, only base text will be returned. Provide a variants filter to specify which variants of the filtered base text items to include.

If both the status and variants filter are provided, variant statuses must match the status filter in addition to their base status matching the status filter to be returned.

Example: {"projects":[{"id":"project-id"}], "variants":[{"id":"french"}], "statuses":["NONE","WIP","FINAL","REVIEW"], "tags":{"values":["tag-1","tag-2"],"operator":"AND"}, "assignee":"user@example.com", "integrated":true}

​
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

​
assignee
string<email> | null
required

The email of the user assigned to this text item, or null if unassigned

​
integrated
boolean
required

Whether this text item has been marked as integrated into development

​
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

​
pluralForm
enum<string> | null
required
Available options:
one,
two,
few,
many,
zero,
other,
null
​
projectId
string
required

The Developer ID of the project this text item belongs to

​
richText
string

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

Example:
[
  {
    "id": "text-item-dev-id",
    "text": "Base text",
    "status": "NONE",
    "notes": "base notes",
    "tags": ["baseTag1", "baseTag2"],
    "assignee": "john@example.com",
    "integrated": true,
    "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"],
    "assignee": "john@example.com",
    "integrated": true,
    "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"],
    "assignee": null,
    "integrated": false,
    "variableIds": ["age", "name"],
    "projectId": "another-project",
    "variantId": null,
    "richText": "Some <strong>base</strong> text"
  }
]