GET
/
components
curl --request GET \
  --url https://api.dittowords.com/v1/components \
  --header 'Authorization: <api-key>'
{
  "footer.about.blog": {
    "name": "Footer/About/Blog",
    "text": "Blog",
    "status": "WIP",
    "folder": null
  },
  "footer.about.careers": {
    "name": "Footer/About/Careers",
    "text": "Careers",
    "status": "FINAL",
    "folder": "folder_1"
  }
}

Authorizations

​
Authorization
string
header
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
​
includeTimeData
boolean

Include the createdAt and updatedAt fields for each component. Only supported for the structured format.

Response

200 - application/json

Returns components

The response is of type string.

Example:
{
  "footer.about.blog": {
    "name": "Footer/About/Blog",
    "text": "Blog",
    "status": "WIP",
    "folder": null
  },
  "footer.about.careers": {
    "name": "Footer/About/Careers",
    "text": "Careers",
    "status": "FINAL",
    "folder": "folder_1"
  }
}