Style guides

List style guides

Returns the style guides available in the workspace. Use style guide IDs when creating orders to apply formatting and transcription preferences. When a style guide with verbatim or sdh enabled is attached to a pro order, the corresponding addons are applied automatically.

get/style_guides

Request

Base URL
https://www.happyscribe.com/api/v1
Auth
API key in header Authorization

Query parameters

workspace_idstring required

Example:wks_01k6a2r9s8x7c2dvq3m5n6p4ab

Workspace ID, beginning with wks_. Treat it as an opaque string. Integer workspace ids are still accepted.

Response

The workspace's style guides.

Example response

{
  "style_guides": [
    {
      "id": 1,
      "name": "Corporate Standard",
      "operation": "transcription",
      "organization_default": true,
      "verbatim": false,
      "fix_grammar": true,
      "sdh": false,
      "speaker_id": "full_name",
      "notation_tags": "standard",
      "created_at": "2024-01-10T09:00:00.000Z",
      "updated_at": "2024-01-20T11:30:00.000Z"
    }
  ]
}

Changes

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