Skip to content
App Translations
Esc
↑↓navigate↵open⌘Jpreview

Get all messages

Every message for one language, in one namespace, several or all of them. An editor's text where there is one, your source's text everywhere else.

GET/umbraco/delivery/api/v1/app-translations/all

Returns every message, for an application that does not bundle its own text. A message an editor changed has the editor’s text. Every other message has the text Umbraco read from your source.

localequerystringrequired

The Umbraco language code. It has to match exactly: da finds nothing on a site that stores da-DK.

namespacequerystring

The namespace. Repeat it, as in namespace=checkout&namespace=website, for several namespaces, or leave it out for every namespace. Up to 20 at once.

formatquerystring

The message syntax your application reads: icu or i18next. Leave it out to get the messages in whatever syntax they are written in.

Api-Keyheaderstring

The delivery key, when one is configured. A bearer token in Authorization works too.

If-None-Matchheaderstring

The ETag of a response you already have. Umbraco answers 304 until something changes.

Response

A JSON object of messages, nested the way your application’s own files are. With one namespace, the namespace’s messages sit at the top level. With several, or none, each namespace is a top-level key holding its own messages, as one namespace, several, or all of them shows. {} when the locale or namespace has none.

Status Meaning
200 The messages.
304 Nothing changed since the ETag you sent.
400 locale is missing, format is not icu or i18next, the request names more than 20 namespaces, or namespace has a comma in it and no namespace has that name.
401 A key is configured, and the request did not send it.
409 The response would hold messages in a syntax format does not read, or, without format, both ICU and i18next messages. Or two sources supply the same key.
Request
curl -X GET 'https://umbraco.example.com/umbraco/delivery/api/v1/app-translations/all?locale=da-DK'
{
  "greeting": "Hej {name}, godt at se dig igen!",
  "farewell": "Vi ses!"
}

Was this page helpful?