Skip to main content

​
Phrase Content Groups API Reference 1.0.20

Content Groups are organization-scoped named containers that connect platform objects across the Phrase product suite. They act as the single matching principle for the translation and quality workflow: a TMS project, its Style Guides, Style Rules, and AI quality checks all resolve through a shared Content Group.

​
Key Features

  • Full group management — create, retrieve, update, and delete Content Groups for your organization
  • Reference listing — retrieve the platform objects linked to a group, with optional filtering by objectType
  • Typed object references — supported types are TMS_PROJECT, TMS_PROJECT_TEMPLATE, PLATFORM_STYLE_GUIDE, PLATFORM_STYLE_RULE, and PLATFORM_QA_CHECK

​
The SYSTEM content group

Every organization has exactly one platform-managed SYSTEM content group, named “All Groups,” representing “applies to all content groups.” It’s created automatically — you never create it yourself — and appears in listGroups/reference-listing results like any other group, distinguished by groupType: SYSTEM on the Group object (all other groups have groupType: USER).
  • Immutable — PUT/DELETE on a SYSTEM group returns 403 Forbidden. Its name and description can never change; only the objects linked to it can.
  • SYSTEM alias — use the literal string SYSTEM in place of a real group id when getting a group or listing its references (GET /groups/{groupId}, GET /groups/{groupId}/references). It is not accepted on PUT/DELETE /groups/{groupId}.
  • includeSystem filter — listGroups and a group’s listGroupReferences both accept includeSystem (default true) to include/exclude the SYSTEM group and its references from results.
  • Restricted object types — PLATFORM_STYLE_GUIDE, TMS_PROJECT, and TMS_PROJECT_TEMPLATE references are never linked to the SYSTEM group; only PLATFORM_QA_CHECK and PLATFORM_STYLE_RULE references can appear under it. You won’t see the restricted types in listGroupReferences results for the SYSTEM group.

​
How Content Groups fit into the platform

Content Groups are the coordination layer across Phrase products. Once a TMS project is linked to a Content Group:
  • The project’s Style Guide and Style Rules are resolved from the group
  • Quality Evaluation draws its checks from the (Content Group, locale) pair
  • AI capabilities receive a Content Profile derived from the group’s rules

​
Base URL

​
Quick Start

  1. Exchange your API token for a JWT via the Authentication guide
  2. Create a Content Group for your organization
  3. Use the group ID when configuring TMS projects or Style Guides in other Phrase products
Browse the full operation set, request and response schemas, and per-endpoint examples in the API Documentation section of the left navigation.