Style guides

Get style guides

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

Each rule includes its developer ID, which can be used with PATCH/DELETE /styleguides/rules. The built-in default style guide is not included.

get/styleguides

Request

  • Base URL: https://api.dittowords.com/v2
  • URL: https://api.dittowords.com/v2/styleguides
  • Auth: API key in header Authorization

Query parameters

developerIdsstring

Comma-separated list of style guide developer IDs to return.

Response

The workspace-created style guides.

Example response

{
  "styleguides": [
    {
      "developerId": "product-guide",
      "name": "Acme Inc.",
      "description": "Voice and tone for Acme Inc. product text.",
      "variant": null,
      "sections": [
        {
          "sectionId": "foundations",
          "name": "Foundations",
          "kind": "rules",
          "rules": [
            {
              "developerId": "be-concise",
              "name": "Be concise",
              "description": "Remove filler words so text is easy to scan.",
              "examples": [
                {
                  "from": "Please click the button below",
                  "to": "Click below"
                }
              ],
              "tags": []
            }
          ]
        },
        {
          "sectionId": "word-list",
          "name": "Word List",
          "kind": "wordlist",
          "rules": [
            {
              "developerId": "ai-agent",
              "term": "AI agent",
              "disallowed": [
                "Bot"
              ],
              "description": "Use 'AI agent' instead of 'bot'.",
              "tags": []
            }
          ]
        }
      ]
    },
    {
      "developerId": "marketing-guide",
      "name": "French",
      "description": "Localized guidance for French text.",
      "variant": {
        "id": "french",
        "name": "French",
        "localeCode": "fr-FR"
      },
      "sections": []
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.