v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Branches

Compare branches

Compare branch with main branch.

Note: Comparing a branch may take several minutes depending on the project size. Consider using the POST /compare endpoint for creating comparison asynchronously.

get/projects/{project_id}/branches/{name}/compare

Path parameters

project_idstring required

Project ID

namestring required

name

Query parameters

namestring

Name of the branch

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

Example response

{
  "translation_keys": {
    "base_changes": [
      {
        "from": {
          "name": "welcome.title",
          "description": null,
          "name_plural": null,
          "is_plural": false,
          "data_type": "string",
          "max_characters_allowed": null,
          "deleted_at": null,
          "locations": [],
          "options": {}
        },
        "to": {
          "name": "welcome.heading",
          "description": null,
          "name_plural": null,
          "is_plural": false,
          "data_type": "string",
          "max_characters_allowed": null,
          "deleted_at": null,
          "locations": [],
          "options": {}
        }
      }
    ],
    "head_changes": [],
    "conflicts": {}
  },
  "translations": {
    "base_changes": [],
    "head_changes": [
      {
        "from": {
          "state": "unverified",
          "content": "Hello",
          "changed_in_main_locale": false,
          "excluded_from_export": false,
          "plural_suffix": null
        },
        "to": {
          "state": "translated",
          "content": "Hello World",
          "changed_in_main_locale": false,
          "excluded_from_export": false,
          "plural_suffix": null
        }
      }
    ],
    "conflicts": {}
  },
  "locales": {
    "base_changes": [],
    "head_changes": [],
    "conflicts": {}
  },
  "tags": {
    "base_changes": [],
    "head_changes": [],
    "conflicts": {}
  }
}