Skip to main content
GET
/
v2
/
translations
/
master-json
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();



$response = $sdk->translations->master->retrieve(
    locale: 'en_US'
);

if ($response->getMasterJsonResponseDto !== null) {
    // handle response
}
{
  "workflows": {
    "welcome-email": {
      "welcome.title": "Welcome to our platform",
      "welcome.message": "Hello there!"
    },
    "password-reset": {
      "reset.title": "Reset your password",
      "reset.message": "Click the link to reset"
    }
  },
  "layouts": {
    "default-layout": {
      "layout.title": "Default layout",
      "layout.message": "Hello there!"
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

Headers

idempotency-key
string

A header for idempotency purposes

Query Parameters

locale
string

Locale to export. If not provided, exports organization default locale

Response

200 - application/json

Master translations JSON retrieved successfully

workflows
object
required

All translations for given locale organized by workflow identifier

Example:
{
"welcome-email": {
"welcome.title": "Welcome to our platform",
"welcome.message": "Hello there!"
},
"password-reset": {
"reset.title": "Reset your password",
"reset.message": "Click the link to reset"
}
}
layouts
object
required

All translations for given locale organized by layout identifier

Example:
{
"default-layout": {
"layout.title": "Default layout",
"layout.message": "Hello there!"
}
}