Get Style Guide | Markup AI

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "display_name": "Corporate Style Guide",
  "language": {
    "display_name": "English",
    "abbreviation": "en"
  },
  "description": "Comprehensive style guide for all corporate communications and branding.",
  "enabled": true,
  "language_variant": {
    "identifier": "en-US",
    "display_name": "English (United States)"
  },
  "goals": [
    {
      "id": "goal-001",
      "identifier": "clarity",
      "display_name": "Clarity",
      "color": "#007ACC",
      "sort_key": 1,
      "goal_groups": [
        {
          "id": "group-001",
          "display_name": "Sentence Structure",
          "sort_key": 1,
          "guidelines": [
            {
              "id": "guideline-001",
              "identifier": "avoid_passive_voice",
              "display_name": "Avoid Passive Voice",
              "guideline_type": "style",
              "context_configurable": false,
              "active": true,
              "parameters": [
                {
                  "name": "severity",
                  "id": "param-001",
                  "label": "Severity Level",
                  "display_name": "Severity"
                }
              ],
              "parameter_value": {
                "severity": "high"
              },
              "contexts": [
                "business",
                "technical"
              ],
              "contexts_filter_type": "include",
              "contexts_active": true,
              "compound_selected_value": null,
              "compound_available_values": []
            }
          ]
        }
      ]
    }
  ]
}

Get a style guide’s full configuration (goals, groups, guidelines).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

style_guide_idstringRequired

Response

Successful Response

idstring

display_namestring

languageobject

descriptionstring or nullOptional

enabledbooleanOptionalDefaults to true

language_variantobject or nullOptional

goalslist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error