> ## Documentation Index
> Fetch the complete documentation index at: https://developer.dittowords.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get style guides

> Returns the style guides created in the workspace, with their sections and rules. The built-in default style guide is not included.



## OpenAPI

````yaml openapi.json get /styleguides
openapi: 3.0.0
info:
  version: 1.0.0
  title: Ditto API
  description: Programmatically read and write data in your Ditto workspace.
servers:
  - url: https://api.dittowords.com/v2
security: []
paths:
  /styleguides:
    get:
      tags:
        - Style guides
      summary: Get style guides
      description: >-
        Returns the style guides created in the workspace, with their sections
        and rules. The built-in default style guide is not included.
      parameters:
        - schema:
            type: string
            description: Comma-separated list of style guide developer IDs to return.
          required: false
          description: Comma-separated list of style guide developer IDs to return.
          name: developerIds
          in: query
      responses:
        '200':
          description: The workspace-created style guides.
          content:
            application/json:
              schema:
                type: object
                properties:
                  styleguides:
                    type: array
                    items:
                      type: object
                      properties:
                        developerId:
                          type: string
                          description: The style guide's developer ID.
                        name:
                          type: string
                          description: The style guide's name.
                        description:
                          type: string
                          description: The style guide's description.
                        variant:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              description: The variant's developer ID.
                            name:
                              type: string
                              description: The variant's name.
                            localeCode:
                              type: string
                              nullable: true
                              description: BCP-47 locale code, or null.
                          required:
                            - id
                            - name
                            - localeCode
                          description: >-
                            The variant/locale this guide is scoped to, or null
                            for a base guide.
                        sections:
                          type: array
                          items:
                            oneOf:
                              - type: object
                                properties:
                                  sectionId:
                                    type: string
                                    description: >-
                                      The section's ID, used to attach rules to
                                      this section.
                                  name:
                                    type: string
                                    description: The section's name.
                                  kind:
                                    type: string
                                    enum:
                                      - rules
                                  rules:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          description: The rule's name.
                                        description:
                                          type: string
                                          description: What the rule enforces.
                                        examples:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              from:
                                                type: string
                                                description: Text that violates the rule.
                                              to:
                                                type: string
                                                description: Corrected version of the text.
                                            required:
                                              - from
                                              - to
                                          description: >-
                                            Before/after examples illustrating the
                                            rule.
                                        tags:
                                          type: array
                                          items:
                                            type: string
                                          description: >-
                                            Tags scoping the rule to specific text
                                            surfaces; empty means it applies
                                            everywhere.
                                      required:
                                        - name
                                        - description
                                        - examples
                                        - tags
                                required:
                                  - sectionId
                                  - name
                                  - kind
                                  - rules
                              - type: object
                                properties:
                                  sectionId:
                                    type: string
                                    description: >-
                                      The section's ID, used to attach rules to
                                      this section.
                                  name:
                                    type: string
                                    description: The section's name.
                                  kind:
                                    type: string
                                    enum:
                                      - wordlist
                                  rules:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        term:
                                          type: string
                                          description: The preferred term this entry governs.
                                        disallowed:
                                          type: array
                                          items:
                                            type: string
                                          description: >-
                                            Disallowed words or phrases that should
                                            be replaced with the term.
                                        description:
                                          type: string
                                          description: >-
                                            Guidance on when and why to use the
                                            term.
                                        tags:
                                          type: array
                                          items:
                                            type: string
                                          description: >-
                                            Tags scoping the entry to specific text
                                            surfaces; empty means it applies
                                            everywhere.
                                      required:
                                        - term
                                        - disallowed
                                        - description
                                        - tags
                                required:
                                  - sectionId
                                  - name
                                  - kind
                                  - rules
                          description: >-
                            The guide's sections, in display order, including
                            empty ones.
                      required:
                        - developerId
                        - name
                        - description
                        - variant
                        - sections
                    description: >-
                      The style guides created in the workspace, with their
                      sections and rules.
                required:
                  - styleguides
                example:
                  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:
                            - 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:
                            - 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: []
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````