Skip to content

docs(developer): document new AP.getContext fields #860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-bodnar merged 1 commit into from
Aug 11, 2026
+35 −2
Merged

docs(developer): document new AP.getContext fields #860

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions src/content/docs/developer/crowdin-apps/apps-js.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ These methods allow your app to get essential information about its environment,
Retrieves a `ContextDataObject` containing key information about the environment where the app is currently running (e.g., project ID, user, and file data).

<Aside>
The payload of this method is dynamic. Depending on the page where your app is loaded (e.g., Editor vs. Project Tools), it may contain a different set of properties.
- The payload of this method is dynamic. Depending on the page where your app is loaded (e.g., Editor vs. Project Tools), it may contain a different set of properties.
- When a value is unavailable, its key is omitted from the context object rather than set to `null`.
</Aside>

**Example:**
Expand Down Expand Up @@ -69,10 +70,14 @@ AP.getContext(function(contextData) {

##### Response Payload Example

```json collapse={12-21,25-59,62-64}
```json collapse={16-25,29-63,66-68}
{
"user_id": 15,
"user_login": "john.smith",
"project_id": 123,
"project_identifier": "docs-portal",
"organization_id": 100001,
"organization_domain": "acme",
"editor": {
"mode": "translate",
"theme": "dark",
Expand Down Expand Up @@ -144,20 +149,48 @@ AP.getContext(function(contextData) {

<table>
<tbody>
<tr>
<td><code>user_id</code></td>
<td>
<p><strong>Type:</strong> <code>integer</code></p>
<p><strong>Description:</strong> The unique numeric ID of the user the app is currently displayed to. Present only for authenticated users.</p>
</td>
</tr>
<tr>
<td><code>user_login</code></td>
<td>
<p><strong>Type:</strong> <code>string</code></p>
<p><strong>Description:</strong> The username of the user the app is currently displayed to. Present only for authenticated users.</p>
</td>
</tr>
<tr>
<td><code>project_id</code></td>
<td>
<p><strong>Type:</strong> <code>integer</code></p>
<p><strong>Description:</strong> The unique numeric ID of the current project.</p>
</td>
</tr>
<tr>
<td><code class="whitespace-nowrap">project_identifier</code></td>
<td>
<p><strong>Type:</strong> <code>string</code></p>
<p><strong>Description:</strong> The identifier of the project the module is opened in. Present when the module runs in a project context and the identifier is available.</p>
</td>
</tr>
<tr>
<td><code>organization_id</code></td>
<td>
<p><strong>Type:</strong> <code>integer</code></p>
<p><strong>Description:</strong> The unique numeric ID of the organization (Crowdin Enterprise only).</p>
</td>
</tr>
<tr>
<td><code class="whitespace-nowrap">organization_domain</code></td>
<td>
<p><strong>Type:</strong> <code>string</code></p>
<p><strong>Description:</strong> The domain of the organization the app is installed in (Crowdin Enterprise only).</p>
</td>
</tr>
<tr>
<td><code>editor</code></td>
<td>
Expand Down
Loading