Return the active workspace template assigned to your organization.

Available to: All authenticated users

Environments: Live

Rate Limit: No endpoint-specific limit

Returns the WorkspaceTemplate currently assigned to the calling user's organization. A workspace template defines a default layout that NinjaTrader applies to traders in the organization. This endpoint takes no parameters: it resolves the organization from the access token, reads that organization's assigned template, and returns it.

The response is an OrgWorkspaceTemplateResponse containing an errorText field and a workspaceTemplate object. When a template is found, workspaceTemplate carries its id and name. The template is returned only when it is active; if the organization's assigned template has been deactivated, no template is returned.

The response omits workspaceTemplate (rather than returning an error) when the organization has no template assigned, when the assigned template is inactive, or when the calling user does not belong to an organization. In each of these cases errorText is empty and workspaceTemplate is absent. Treat a missing workspaceTemplate as "no active template assigned," not as a failure.

Assigning a template to an organization is an internal NinjaTrader administrative operation and is not part of the partner API. To enumerate the templates available in your environment, use workspaceTemplateList.

Common Failure Scenarios

• The access token is missing or invalid (returns HTTP 401).
• The organization has no active workspace template assigned. This is not an error: the request succeeds with an empty workspaceTemplate.

Error Messages