Retrieve a translation

Retrieve a specific translation by resource type, resource ID and locale

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

localeRequiredstring

Locale code

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

Translation found

resourceIdRequiredstring

Resource identifier

resourceTypeRequiredstring

Resource type

Value in: "workflow" | "layout"

localeRequiredstring

Locale code

contentRequiredobject

Translation content as JSON object

createdAtRequiredstring

Creation timestamp

updatedAtRequiredstring

Last update timestamp

export interface Response {
  /**
   * Resource identifier
   */
  resourceId: string;
  /**
   * Resource type
   */
  resourceType: "workflow" | "layout";
  /**
   * Locale code
   */
  locale: string;
  /**
   * Translation content as JSON object
   */
  content: {};
  /**
   * Creation timestamp
   */
  createdAt: string;
  /**
   * Last update timestamp
   */
  updatedAt: string;
}

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

{
  "resourceId": "welcome-email",
  "resourceType": "workflow",
  "locale": "en_US",
  "content": {
    "welcome.title": "Welcome",
    "welcome.message": "Hello there!"
  },
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

Retrieve a translation

Authorization

Path Parameters

Header Parameters

Response Body

On this page