Skip to main content
GET
Get Quality Profile by Content Group

Authorizations

Authorization
string
header
required

Use a Bearer token obtained from Phrase Platform authentication. See the Authentication guide for details on how to obtain a token.

Path Parameters

contentGroupId
string
required

ID of the Content Group whose Quality Profile is to be retrieved.

Query Parameters

locale
string<locale>

When provided, only rules that apply to the given locale are returned. When absent, all rules for the Content Group are returned regardless of locale restrictions. Locale code compatible with the Phrase locale format. Case-insensitive; accepts _ or - as the separator (for example en_us, en-US, de_de). Responses use lowercase codes.

Example:

"en_us"

checkEnabled
boolean

Filters rules by their aiCheckEnabled state. When absent, rules are returned regardless of state.

checkText
string

Case-insensitive contains-match filter on the rule requirement text. When absent, rules are returned regardless of their text.

Maximum string length: 450
sort
enum<string>

Sort field.

Available options:
checkEnabled
order
enum<string>
default:asc

Sort order. Only applied when sort is provided.

Available options:
asc,
desc

Response

Quality Profile resolved successfully.

Quality Profile resolved from a Content Group: the active Rules that apply to it.

rules
object[]
required

Active rules for the given Content Group. Includes rules with AI Check disabled; see aiCheckEnabled on each rule.