list_translatable_strings

readSince v1.0

Collect every piece of text in the model that can be translated, in one place. That means the model's own name and description, your types and their properties, every node and relationship with its labels, descriptions and property values, diagrams, grid views, folders, filters and assets, the whole publishing layer (navigation trees and each branch's title and lead text, document renderings and their document bodies, publications and their homepages), and the entire simulation layer down to dashboard chart titles, axis labels and slider captions.

Use this before translate_elements rather than guessing what needs translating — dashboard text in particular is easy to miss otherwise. Each entry gives you the key to translate against, the original text, and (if you name a target language) whether it has been translated yet. Pass a target language with only_missing to get just the work still outstanding.

Results come back a page at a time, because a large model has more text than fits in one response. Keep calling with the next_offset from the previous result until has_more comes back false.

Parameters

NameTypeRequiredDefaultDescription
target_languageStringLanguage you're translating into (for example 'de'). When you set it, each entry says whether it has been translated yet, and you get a summary of how many strings are done and how many remain. The original text is always reported in the model's own default language regardless of this setting.
only_missingBooleanfalseReturn just the text that has not been translated into the target language yet — the outstanding work-list. Requires target_language.
offsetNumberHow many entries to skip. Pass the next_offset from the previous result to fetch the following page.
limitNumber100How many entries to return in this page. Maximum 500.

Example Request

{"target_language": "de", "only_missing": true, "limit": 100}

Example Response

{"total": 812, "matched": 137, "returned": 100, "has_more": true, "next_offset": 100, "summary": {"total": 812, "translated": 675, "missing": 137}, "strings": [{"key": "9f0c...:label", "source": "OAuth Integration", "translated": false}]}

This content was written collaboratively with AI.