Skip to main content
GET
/
components
Fetch components
curl --request GET \
  --url https://api.dittowords.com/v2/components \
  --header 'Authorization: <api-key>'
[
  {
    "id": "component-item-dev-id",
    "text": "Base text",
    "status": "NONE",
    "notes": "base notes",
    "tags": [
      "baseTag1",
      "baseTag2"
    ],
    "assignee": "john@example.com",
    "variableIds": [],
    "folderId": "folder-dev-id",
    "variantId": null,
    "richText": "<strong>Base</strong> text"
  },
  {
    "id": "component-item-dev-id",
    "text": "French text",
    "status": "WIP",
    "notes": "base notes",
    "tags": [
      "baseTag1",
      "baseTag2"
    ],
    "assignee": "john@example.com",
    "variableIds": [
      "age",
      "name"
    ],
    "folderId": "folder-dev-id",
    "variantId": "french",
    "richText": "<em>French</em> text"
  },
  {
    "id": "component-item-dev-id-2",
    "text": "Some base text",
    "status": "FINAL",
    "notes": "base notes",
    "tags": [
      "baseTag1",
      "baseTag2"
    ],
    "assignee": null,
    "variableIds": [
      "age",
      "name"
    ],
    "folderId": null,
    "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:

  • folders: array of objects with id (folder developer ID or root for root-level components) and optional excludeNestedFolders (boolean)
  • variants: array of objects with id (variant developer ID, base, or all)
  • statuses: array of status strings (NONE, WIP, REVIEW, FINAL)

By default, only base text will be returned. Provide a variants filter to specify which variants of the filtered components 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.

By default, folder filters search for components in that folder and its folder children. To skip searching folder children for a given folder, set excludeNestedFolders to true.

Example: {"folders":[{"id":"folder-id"},{"id":"folder-id-2","excludeNestedFolders":true}],"variants":[{"id":"french"}],"statuses":["NONE","WIP","FINAL","REVIEW"]}

​
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 components matching the filter criteria

​
id
string
required

The Developer ID of the component

​
text
string
required

The plaintext content of the component. 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 component. Variants will have the base component's notes value

​
tags
string[]
required

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

​
assignee
string<email> | null
required

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

​
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
​
folderId
string | null
required

The Developer ID of the folder this component belongs to

​
richText
string

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

Example:
[
  {
    "id": "component-item-dev-id",
    "text": "Base text",
    "status": "NONE",
    "notes": "base notes",
    "tags": ["baseTag1", "baseTag2"],
    "assignee": "john@example.com",
    "variableIds": [],
    "folderId": "folder-dev-id",
    "variantId": null,
    "richText": "<strong>Base</strong> text"
  },
  {
    "id": "component-item-dev-id",
    "text": "French text",
    "status": "WIP",
    "notes": "base notes",
    "tags": ["baseTag1", "baseTag2"],
    "assignee": "john@example.com",
    "variableIds": ["age", "name"],
    "folderId": "folder-dev-id",
    "variantId": "french",
    "richText": "<em>French</em> text"
  },
  {
    "id": "component-item-dev-id-2",
    "text": "Some base text",
    "status": "FINAL",
    "notes": "base notes",
    "tags": ["baseTag1", "baseTag2"],
    "assignee": null,
    "variableIds": ["age", "name"],
    "folderId": null,
    "variantId": null,
    "richText": "Some <strong>base</strong> text"
  }
]