GET
/
projects
/
{id}
curl --request GET \
  --url https://api.dittowords.com/v1/projects/{id} \
  --header 'Authorization: <api-key>'
{
  "frames": {
    "frame_6024cb5c57023a00a2ca8891": {
      "blocks": {
        "buttons": {
          "text_6024cb5c57023a00a2ca8854": {
            "status": "REVIEW",
            "text": "Continue"
          }
        },
        "form": {
          "text_6024cb5c57023a00a2ca8858": {
            "status": "REVIEW",
            "text": "Basic"
          },
          "text_6024cb5c57023a00a2ca885a": {
            "status": "REVIEW",
            "text": "$48"
          }
        },
        "headings": {
          "text_6024cb5c57023a00a2ca8856": {
            "notes": "a note!",
            "status": "REVIEW",
            "tags": [
              "ONBOARDING"
            ],
            "text": "Pick your pricing plan."
          },
          "text_6024cb5c57023a00a2ca8857": {
            "status": "REVIEW",
            "text": "If you have any questions regarding pricing, please visit our detailed pricing page. "
          }
        }
      },
      "frameName": "Pricing",
      "otherText": {
        "text_6024cb5c57023a00a2ca8855": {
          "text": "Step 2 of 4"
        },
        "text_6024cb5c57023a00a2ca8859": {
          "text": "Our Basic Plan provides integrations with Slack and WhatsApp."
        },
        "text_6024cb5c57023a00a2ca885b": {
          "text": "Team"
        },
        "text_6024cb5c57023a00a2ca885c": {
          "text": "Our Team Plan includes everything in the Basic Plan, in addition to unlimited messages between members of your workspace."
        },
        "text_6024cb5c57023a00a2ca885d": {
          "text": "$98"
        },
        "text_6024cb5c57023a00a2ca885e": {
          "is_comp": true,
          "notes": "Should be used in any funnels in the app (onboarding, upgrade, etc.)",
          "tags": [
            "CTA",
            "ONBOARDING"
          ],
          "text": "Continue"
        }
      }
    },
    "welcome": {
      "frameName": "Welcome",
      "otherText": {
        "text": {
          "text": "name@company.com"
        },
        "text_6024cb5c57023a00a2ca884e": {
          "tags": [
            "WELCOME_CTA"
          ],
          "text": "Continue"
        },
        "text_6024cb5c57023a00a2ca8851": {
          "tags": [
            "BODY",
            "ENGLISH"
          ],
          "text": "What is your work email address?"
        },
        "text_6024cb5c57023a00a2ca8853": {
          "is_comp": true,
          "notes": "Should be used in any funnels in the app (onboarding, upgrade, etc.)",
          "tags": [
            "CTA",
            "ONBOARDING"
          ],
          "text": "Continue"
        }
      }
    }
  },
  "project_name": "Onboarding Flow"
}

Authorizations

Authorization
string
headerrequired

Path Parameters

id
string
required

Query Parameters

variant
string
format
enum<string>
Available options:
flat,
structured,
nested,
icu,
android,
ios-strings,
ios-strings-dict
status
enum<string>
Available options:
NONE,
WIP,
REVIEW,
FINAL
includeRichText
boolean
exclude_components
boolean

Response

200 - application/json
  • Option 1

  • Option 2

  • Option 3

The response is of type string.