Skip to main content
GET
/
styleguides
Get style guides
curl --request GET \
  --url https://api.dittowords.com/v2/styleguides \
  --header 'Authorization: <api-key>'
{
  "styleguides": [
    {
      "name": "Acme Inc.",
      "description": "Voice and tone for Acme Inc. product text.",
      "variant": null,
      "sections": [
        {
          "name": "Foundations",
          "kind": "rules",
          "rules": [
            {
              "name": "Be concise",
              "description": "Remove filler words so text is easy to scan.",
              "examples": [
                {
                  "from": "Please click the button below",
                  "to": "Click below"
                }
              ],
              "tags": []
            }
          ]
        },
        {
          "name": "Word List",
          "kind": "wordlist",
          "rules": [
            {
              "term": "AI agent",
              "disallowed": [
                "Bot"
              ],
              "description": "Use 'AI agent' instead of 'bot'.",
              "tags": []
            }
          ]
        }
      ]
    },
    {
      "name": "French",
      "description": "Localized guidance for French text.",
      "variant": {
        "id": "french",
        "name": "French",
        "localeCode": "fr-FR"
      },
      "sections": []
    }
  ]
}

Authorizations

Authorization
string
header
required

Response

200 - application/json

The workspace-created style guides.

styleguides
object[]
required

The style guides created in the workspace, with their sections and rules.