Retrieve style rule lists

Changed on

List the style rule lists in your account. Results are paginated. Set detailed to include each list's configured rules and custom instructions.

get/v3/style_rules

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v3/style_rules
  • Auth
    API key in header Authorization

Query parameters

pageinteger

The index of the first page to return. Use with page_size to get the next page of rule lists

page_sizeinteger

The maximum number of style rule lists to return.

detailedboolean

Determines if the rule list's configured_rules and custom_instructions should be included in the response body.

Response

JSON object containing the style rule lists.

Example response

{
  "style_rules": [
    {
      "style_id": "bd0a38f3-1831-440b-a8dd-2c702e2325ab",
      "version": 13,
      "configured_rules": {
        "style_and_tone": {
          "abbreviations": "use_abbreviations_and_symbols",
          "short_vs_long_words": "use_short_words"
        },
        "punctuation": {
          "apostrophe": "use_curly_apostrophes"
        }
      },
      "custom_instructions": [
        {
          "id": "68fdb803-c013-4e67-b62e-1aad0ab519cd",
          "label": "Currency custom instruction",
          "prompt": "Have currency symbols before the numerical value (e.g. $100, €100)",
          "source_language": "en"
        }
      ]
    }
  ]
}

Changes

    • warning

      added the new ar enum value to the // response property for the response status

    • warning

      added the new bg enum value to the // response property for the response status

    • warning

      added the new cs enum value to the // response property for the response status

    • warning

      added the new da enum value to the // response property for the response status

    • warning

      added the new de-CH enum value to the // response property for the response status

    • warning

      added the new de-DE enum value to the // response property for the response status

    • warning

      added the new el enum value to the // response property for the response status

    • warning

      added the new en-GB enum value to the // response property for the response status

    • warning

      added the new en-US enum value to the // response property for the response status

    • warning

      added the new es-419 enum value to the // response property for the response status

    • warning

      added the new es-ES enum value to the // response property for the response status

    • warning

      added the new et enum value to the // response property for the response status

    • warning

      added the new fi enum value to the // response property for the response status

    • warning

      added the new fr-CA enum value to the // response property for the response status

    • warning

      added the new fr-FR enum value to the // response property for the response status

    • warning

      added the new he enum value to the // response property for the response status

    • warning

      added the new hu enum value to the // response property for the response status

    • warning

      added the new id enum value to the // response property for the response status

    • warning

      added the new lt enum value to the // response property for the response status

    • warning

      added the new lv enum value to the // response property for the response status

    • warning

      added the new nb enum value to the // response property for the response status

    • warning

      added the new nl enum value to the // response property for the response status

    • warning

      added the new pl enum value to the // response property for the response status

    • warning

      added the new pt enum value to the // response property for the response status

    • warning

      added the new pt-BR enum value to the // response property for the response status

    • warning

      added the new pt-PT enum value to the // response property for the response status

    • warning

      added the new ro enum value to the // response property for the response status

    • warning

      added the new ru enum value to the // response property for the response status

    • warning

      added the new sk enum value to the // response property for the response status

    • warning

      added the new sl enum value to the // response property for the response status

    • warning

      added the new sv enum value to the // response property for the response status

    • warning

      added the new th enum value to the // response property for the response status

    • warning

      added the new tr enum value to the // response property for the response status

    • warning

      added the new uk enum value to the // response property for the response status

    • warning

      added the new vi enum value to the // response property for the response status

    • warning

      added the new zh-Hans enum value to the // response property for the response status

    • warning

      added the new zh-Hant enum value to the // response property for the response status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status