Skip to main content
GET
/
projects
/
{id}
/
components
Fetch component text by project id
curl --request GET \
  --url https://api.dittowords.com/v1/projects/{id}/components \
  --header 'Authorization: <api-key>'
{
  "introduction": {
    "name": "Introduction",
    "text": "Welcome to Ditto",
    "status": "FINAL",
    "folder": null,
    "tags": [
      "HOMEPAGE"
    ],
    "notes": "Show on the homepage for new users",
    "variants": {}
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

Query Parameters

​
variant
string

The API ID of the variant. If specified, will filter for components that have the variant, and will return the attributes (e.g. text, status) of that component's variant.

Example:

"french"

​
format
enum<string>
Available options:
flat,
structured,
nested,
icu,
android,
ios-strings,
ios-strings-dict
Example:

"structured"

​
status
enum<string>
Available options:
NONE,
WIP,
REVIEW,
FINAL
Example:

"FINAL"

​
includeRichText
boolean

Response

200 - application/json

Returns components a project

  • Option 1 · string
  • Option 2 · object
  • Option 3 · object

The response is of type string.

Example:
{
  "introduction": {
    "name": "Introduction",
    "text": "Welcome to Ditto",
    "status": "FINAL",
    "folder": null,
    "tags": ["HOMEPAGE"],
    "notes": "Show on the homepage for new users",
    "variants": {}
  }
}