Sign in

v1

latestOpenAPI 3.1.02026-07-265094114.0 KB
Styles

Retrieve all style guides

Returns a list of style guides available to your workspace, sorted from most recently created

get/v1/styles

Response

The list of all style guides in the workspace.

idstring required

The style guide's unique ID

namestring required

The style guide's name

descriptionstring required

The style guide's description

customInstructionsstring nullable required

Free-form custom instructions for the style guide

createdAtstring required

When the style guide was created

createdBystring nullable required

The user ID of who created the style guide

updatedAtstring required

When the style guide was last updated

termsstring[] required
rulesstring[] required

Example response

{
  "id": "sty_f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0",
  "name": "My Style Guide",
  "description": "A style guide for marketing content",
  "customInstructions": "Always use a friendly, conversational tone.",
  "createdAt": "2025-01-15T12:00:00.000Z",
  "createdBy": "usr_abc123",
  "updatedAt": "2025-01-20T14:30:00.000Z",
  "terms": [
    {
      "type": "REPLACE",
      "term": "waz",
      "replaceWith": "What's"
    },
    {
      "type": "ABBREVIATE_AFTER_FIRST",
      "term": "Mergers & Acquisitions",
      "replaceWith": "M&A"
    },
    {
      "type": "REPLACE_FIRST_INSTANCE",
      "term": "Jasper®",
      "replaceWith": "Jasper"
    }
  ],
  "rules": [
    {
      "name": "activeVoice",
      "type": "boolean",
      "value": true,
      "ignore": "enabled"
    },
    {
      "name": "contractions",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "emDashAside",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "emDashSpaces",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "enDashRanges",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "exclamationPoints",
      "type": "boolean",
      "value": true,
      "ignore": "enabled"
    },
    {
      "name": "formatNumerals",
      "type": "boolean",
      "value": true,
      "ignore": "enabled"
    },
    {
      "name": "locale",
      "type": "locale",
      "value": "EN_US",
      "ignore": "enabled"
    },
    {
      "name": "oxfordComma",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "removeAmpersands",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "removePlusAsAnd",
      "type": "boolean",
      "value": true,
      "ignore": "enabled"
    },
    {
      "name": "removeSemicolons",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "spacesAfterPeriod",
      "type": "number",
      "value": 1,
      "ignore": "disabled"
    },
    {
      "name": "spellNumbers",
      "type": "number",
      "value": 100,
      "ignore": "enabled"
    }
  ]
}