Translation API Overview

The Translation REST API gives programmatic access to every translation in the Magentrix Translation Studio. Use it to build pipelines, integrate with external translation services, sync glossaries across portals, or automate large translation efforts that don't fit the Studio editor or CSV import flow.

This page covers the base URL, authentication, authorization, content types, and request/response conventions. See the companion pages for the full describe and translation endpoint reference.

Base URL and Content Type

• Base URL:https://{instance}/api/3.0/
• All translation endpoints are under /api/3.0/translations/ and /api/3.0/translations.
• Content Type:application/json
• Encoding: UTF-8

Authentication

All API calls require a Bearer token obtained via the platform's token endpoint.

POST /api/3.0/token
Content-Type: application/json

{
  "grant_type": "refresh_token",
  "refresh_token": "YOUR_REFRESH_TOKEN"
}

Response:

{
  "token": "ACCESS_TOKEN_STRING",
  "dateIssued": "5/15/2026 3:01:28 PM",
  "validUntil": "5/15/2026 7:01:28 PM",
  "success": true
}

The token field in the response is named token (not access_token). Tokens are valid for the duration of your portal's session timeout — check the validUntil field in the response rather than assuming a fixed window. Pass the token as a Bearer header on every subsequent request:

Authorization: Bearer ACCESS_TOKEN

Authorization

Translation endpoints require one of:

• A host user.
• An internal user whose Security Role has Enable Translation Studio Access granted.

Calls made without one of these return HTTP 403:

{
  "success": false,
  "errors": ["Insufficient permissions."]
}

Endpoint Map

Request Conventions

• GET parameters — passed as query string.
• POST body — JSON object with language and translations array.
• Language codes — lowercase ISO-style codes (fr, de, es, it, pt, zh, ja, ru, pt-BR, es-MX). See the Translation Types Reference for the full list and supported types.
• Type values — case-insensitive on the wire; documented as Entity, Field, etc.

Response Conventions

• Success — HTTP 200 with the requested data (GET) or a summary object with success: true (POST).
• Failure — non-2xx HTTP status and a JSON body with success: false and an errors array of strings.

Workflow at a Glance

1. Authenticate — obtain a Bearer token.
2. GET /translations/languages — discover active languages.
3. GET /translations/describe?type=... — discover translatable items.
4. GET /translations?language=...&type=... — fetch master values and current translations.
5. POST /translations — submit new or updated translations.

Detailed flows and full request / response examples are documented in:

• Describe Endpoints — languages, types, entities, fields, picklists, apps, tabs, custom labels.
• Get and Submit Translations — GET and POST /translations.
• Translation Types Reference — 11 types and their aspects.

Related Documentation

• Using the Translation Studio — admin overview of the Studio.
• Bulk Importing Translations — CSV-based bulk path.
• Getting Started with the REST API — general API patterns.

Describe Endpoints >>