Retrieve a translation group

Retrieves a single translation group by resource type (workflow, layout) and resource ID (workflowId, layoutId)

Authorization

Authorization<token>

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

In: header

Authorization<token>

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

In: header

Path Parameters

resourceTypeRequiredstring

Resource type

Value in: "workflow" | "layout"

resourceIdRequiredstring

Resource ID

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

Translation group details

resourceIdRequiredstring

Resource identifier (slugified ID)

resourceTypeRequiredstring

Resource type

Value in: "workflow" | "layout"

resourceNameRequiredstring

Resource name (e.g., workflow name)

localesRequiredarray<string>

Array of available locales for this resource

outdatedLocalesarray<string>

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

createdAtRequiredstring

Creation timestamp

updatedAtRequiredstring

Last update timestamp

export interface Response {
  /**
   * Resource identifier (slugified ID)
   */
  resourceId: string;
  /**
   * Resource type
   */
  resourceType: "workflow" | "layout";
  /**
   * Resource name (e.g., workflow name)
   */
  resourceName: string;
  /**
   * Array of available locales for this resource
   */
  locales: string[];
  /**
   * Locales that are outdated compared to the default locale (only present when there are outdated locales)
   */
  outdatedLocales?: string[];
  /**
   * Creation timestamp
   */
  createdAt: string;
  /**
   * Last update timestamp
   */
  updatedAt: string;
}

curl -X GET "https://api.novu.co/v2/translations/group/workflow/welcome-email" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

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

Retrieve a translation group

Authorization

Path Parameters

Header Parameters

Response Body

On this page