Retrieve a translation group

GET

translations

group

{resourceType}

{resourceId}

TypeScript

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.translations.groups.retrieve("workflow", "welcome-email");

  console.log(result);
}

run();

using Novu;
using Novu.Models.Components;
using Novu.Models.Requests;

var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");

var res = await sdk.Translations.Groups.RetrieveAsync(
    resourceType: TranslationControllerGetTranslationGroupEndpointPathParamResourceType.Workflow,
    resourceId: "welcome-email"
);

// handle response

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Operations;

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



$response = $sdk->translations->groups->retrieve(
    resourceType: Operations\TranslationControllerGetTranslationGroupEndpointPathParamResourceType::Workflow,
    resourceId: 'welcome-email'

);

if ($response->translationGroupDto !== null) {
    // handle response
}

import novu_py
from novu_py import Novu


with Novu(
    secret_key="YOUR_SECRET_KEY_HERE",
) as novu:

    res = novu.translations.groups.retrieve(resource_type=novu_py.TranslationControllerGetTranslationGroupEndpointPathParamResourceType.WORKFLOW, resource_id="welcome-email")

    # Handle response
    print(res)

package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.Translations.Groups.Retrieve(ctx, operations.TranslationControllerGetTranslationGroupEndpointPathParamResourceTypeWorkflow, "welcome-email", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.TranslationGroupDto != nil {
        // handle response
    }
}

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.novu.co/v2/translations/group/{resourceType}/{resourceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.novu.co/v2/translations/group/{resourceType}/{resourceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "resourceId": "welcome-email",
  "resourceType": "workflow",
  "resourceName": "Welcome Email Workflow",
  "locales": [
    "en_US",
    "es_ES",
    "fr_FR"
  ],
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "outdatedLocales": [
    "es_ES",
    "fr_FR"
  ]
}

Authorizations

Authorization

string

header

required

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

Headers

idempotency-key

string

A header for idempotency purposes

Path Parameters

resourceType

enum<string>

required

Resource type

Available options:

workflow,

layout

resourceId

string

required

Resource ID

Response

Translation group details

resourceId

string

required

Resource identifier (slugified ID)

Example:

"welcome-email"

resourceType

enum<string>

required

Resource type

Available options:

workflow,

layout

Example:

"workflow"

resourceName

string

required

Resource name (e.g., workflow name)

Example:

"Welcome Email Workflow"

locales

string[]

required

Array of available locales for this resource

Example:

["en_US", "es_ES", "fr_FR"]

createdAt

string

required

Creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

updatedAt

string

required

Last update timestamp

Example:

"2024-01-01T00:00:00.000Z"

outdatedLocales

string[]

Locales that are outdated compared to the default locale (only present when there are outdated locales)

Example:

["es_ES", "fr_FR"]

⌘I

TypeScript

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.translations.groups.retrieve("workflow", "welcome-email");

  console.log(result);
}

run();

using Novu;
using Novu.Models.Components;
using Novu.Models.Requests;

var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");

var res = await sdk.Translations.Groups.RetrieveAsync(
    resourceType: TranslationControllerGetTranslationGroupEndpointPathParamResourceType.Workflow,
    resourceId: "welcome-email"
);

// handle response

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Operations;

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



$response = $sdk->translations->groups->retrieve(
    resourceType: Operations\TranslationControllerGetTranslationGroupEndpointPathParamResourceType::Workflow,
    resourceId: 'welcome-email'

);

if ($response->translationGroupDto !== null) {
    // handle response
}

import novu_py
from novu_py import Novu


with Novu(
    secret_key="YOUR_SECRET_KEY_HERE",
) as novu:

    res = novu.translations.groups.retrieve(resource_type=novu_py.TranslationControllerGetTranslationGroupEndpointPathParamResourceType.WORKFLOW, resource_id="welcome-email")

    # Handle response
    print(res)

package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.Translations.Groups.Retrieve(ctx, operations.TranslationControllerGetTranslationGroupEndpointPathParamResourceTypeWorkflow, "welcome-email", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.TranslationGroupDto != nil {
        // handle response
    }
}

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.novu.co/v2/translations/group/{resourceType}/{resourceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.novu.co/v2/translations/group/{resourceType}/{resourceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "resourceId": "welcome-email",
  "resourceType": "workflow",
  "resourceName": "Welcome Email Workflow",
  "locales": [
    "en_US",
    "es_ES",
    "fr_FR"
  ],
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "outdatedLocales": [
    "es_ES",
    "fr_FR"
  ]
}

Getting Started

Events

Subscribers

Inbox

Topics

Notifications

Workflows

Translations

Contexts

Environments

Environment Variables

Messages

Integrations

Channel Connections

Channel Endpoints

Activity

Layouts

Contexts

Environments

Activity

Layouts

Subscribers

Topics

Translations

Workflows

Channel Connections

Channel Endpoints

Domains

Environment Variables

Events

Integrations

Messages

Notifications

Retrieve a translation group

Authorizations

Headers

Path Parameters

Response