Retrieve a style profile

Learn how to fetch a single style profile’s linked components, metadata, and timestamps by its ID.

GET /v3/style_profiles/{style_profile_id}

Retrieve a style profile

cURL

curl --request GET \
  --url https://api.deepl.com/v3/style_profiles/{style_profile_id} \
  --header 'Authorization: <api-key>'

200

{
  "style_profile_id": "3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47",
  "name": "Legal, German",
  "description": "Contract wording for the German market.",
  "industry": "Legal",
  "glossary_ids": [
    "4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81"
  ],
  "style_rule_ids": [
    "bd0a38f3-1831-440b-a8dd-2c702e2325ab"
  ],
  "translation_memory_ids": [
    "a74d88fb-ed2a-4943-a664-a4512398b994"
  ],
  "example_document_ids": [
    "9e7b41c2-58da-4a03-b6f1-3c85e0d97a26"
  ],
  "spoken_terms_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "glossary_priority_enabled": true,
  "creation_time": "2026-04-01T16:34:25.223Z",
  "updated_time": "2026-08-06T09:12:44.108Z"
}

Authorizations

Authorization · string · header · default: DeepL-Auth-Key · required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Path Parameters

style_profile_id · string<uuid> · required

The ID of the style profile to retrieve. A unique ID assigned to a style profile.

Example:

"3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47"

Response

200

application/json

Returns the style profile.

style_profile_id · string<uuid> · required

A unique ID assigned to a style profile.

Example:

"3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47"

name · string · required

Name associated with the style profile. At most 255 characters. A style profile always has a name, so it cannot be cleared once it is set.

Example:

"Legal, German"

glossary_ids · string<uuid>[] · required

The IDs of the glossaries linked to the style profile, in the order they are applied.

Example:

["4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81"]

style_rule_ids · string<uuid>[] · required

The IDs of the style rule lists linked to the style profile, in the order they are applied.

Example:

["bd0a38f3-1831-440b-a8dd-2c702e2325ab"]

translation_memory_ids · string<uuid>[] · required

The IDs of the translation memories linked to the style profile, in the order they are applied. A style profile links at most one translation memory per source language.

Example:

["a74d88fb-ed2a-4943-a664-a4512398b994"]

example_document_ids · string<uuid>[] · required

The IDs of the example documents linked to the style profile, in the order they are applied.

Example:

["9e7b41c2-58da-4a03-b6f1-3c85e0d97a26"]

glossary_priority_enabled · boolean · required

Whether the glossaries linked to the style profile take priority over its other components.

Example:

true

creation_time · string<date-time> · required

The creation time of the style profile in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).

Example:

"2026-04-01T16:34:25.223Z"

updated_time · string<date-time> · required

The time of the last update to the style profile in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).

Example:

"2026-08-06T09:12:44.108Z"

description · string

Free-text description of the style profile. At most 1000 characters. Omitted from the response when the style profile has no description.

Example:

"Contract wording for the German market."

industry · string

The industry the style profile is written for. At most 255 characters. Omitted from the response when the style profile has no industry.

Example:

"Legal"

spoken_terms_id · string<uuid>

The ID of the Spoken Terms collection linked to the style profile, applied when the profile is used for speech rather than text. A style profile links at most one collection. Omitted from the response when no collection is linked. Collections are managed with the Spoken Terms endpoints.

Example:

"def3a26b-3e84-45b3-84ae-0c0aaf3525f7"