GET
/
component-folders
/
{api_id}
/
components
Fetch component text by component folder
curl --request GET \
  --url https://api.dittowords.com/v1/component-folders/{api_id}/components \
  --header 'Authorization: <api-key>'
{
  "example_component_1": {
    "name": "Component Name",
    "text": "This is some component text",
    "status": "WIP",
    "folder": "folder_1"
  },
  "example_component_2": {
    "name": "Another Component Name",
    "text": "This is some more component text",
    "status": "FINAL",
    "folder": "folder_1"
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
api_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 a component folder's components

The response is of type string.

Example:
{
  "example_component_1": {
    "name": "Component Name",
    "text": "This is some component text",
    "status": "WIP",
    "folder": "folder_1"
  },
  "example_component_2": {
    "name": "Another Component Name",
    "text": "This is some more component text",
    "status": "FINAL",
    "folder": "folder_1"
  }
}