Retrieve master translations JSON

Retrieve all translations for a locale in master JSON format organized by resourceId (workflowId)

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

Query Parameters

localestring

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

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

Master translations JSON retrieved successfully

workflowsRequiredobject

All translations for given locale organized by workflow identifier

layoutsRequiredobject

All translations for given locale organized by layout identifier

export interface Response {
  /**
   * All translations for given locale organized by workflow identifier
   */
  workflows: {};
  /**
   * All translations for given locale organized by layout identifier
   */
  layouts: {};
}

curl -X GET "https://api.novu.co/v2/translations/master-json?locale=en_US" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

{
  "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!"
    }
  }
}

Retrieve master translations JSON

Authorization

Query Parameters

Header Parameters

Response Body

On this page