Outcome
Read the workspace's template brand settings (brand name, logo, primary colour, footer text, postal address) and the brand emails actually render with, including which source supplied each value (brand, settings or default). A bound TopoloBrand kit wins; when Brand is unbound or unavailable the settings apply. Unset values render neutral; nothing is invented.
Before you start
- Verify identity and pin the intended organization and environment before discovering the action.
- Discover a granted Nurture workspace. The application permission is workspace:read; required workspace access is read. A permission alone does not supply a workspace grant.
- Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.
Discover the target
topolo whoami --json
topolo actions get app_topolo_nurture.template_brand.get --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
Request
GET /api/template-brand
Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.
Inspect and test this action in the signed action console. A test response still requires the verification below.
Input fields
Use an empty JSON object; verified credential and resource context are separate.
Exact input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}
Effects
- Reads brand settings without changing state.
Interpret the response
This is a workspace configuration or policy response, not an independently identified resource. Inspect its values and verify changes with the corresponding read action.
Check $.brand.sources to see where each rendered value came from.
Exact success schema:
{
"type": "object",
"required": [
"settings",
"brand"
],
"properties": {
"settings": {
"type": "object",
"properties": {
"brandName": {
"type": [
"string",
"null"
]
},
"logoUrl": {
"type": [
"string",
"null"
]
},
"primaryColor": {
"type": [
"string",
"null"
]
},
"footerText": {
"type": [
"string",
"null"
]
},
"postalAddress": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": [
"string",
"null"
]
}
}
},
"brand": {
"type": "object",
"required": [
"sources"
],
"properties": {
"brandName": {
"type": [
"string",
"null"
]
},
"logoUrl": {
"type": [
"string",
"null"
]
},
"primaryColor": {
"type": [
"string",
"null"
]
},
"footerText": {
"type": [
"string",
"null"
]
},
"postalAddress": {
"type": [
"string",
"null"
]
},
"sources": {
"type": "object"
}
}
}
}
}
Worked examples
Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.
Successful request
Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_nurture.template_brand.get --data @payload.json --json
topolo actions plan app_topolo_nurture.template_brand.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.template_brand.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_nurture.template_brand.get",
"input": {},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>"
}
}
Captured local response · HTTP 200:
{
"settings": {
"brandName": null,
"logoUrl": null,
"primaryColor": null,
"footerText": null,
"postalAddress": null,
"updatedAt": null
},
"brand": {
"sources": {
"brandName": "default",
"logoUrl": "default",
"primaryColor": "default",
"footerText": "default",
"postalAddress": "default",
"logoAlt": "default",
"darkPrimaryColor": "default",
"legalEntityName": "default",
"unsubscribeText": "default"
},
"brandName": null,
"logoUrl": null,
"primaryColor": null,
"footerText": null,
"postalAddress": null,
"logoAlt": null,
"darkPrimaryColor": null,
"legalEntityName": null,
"unsubscribeText": null
}
}
HTTP 200. Check $.brand.sources to see where each rendered value came from.
Another supported request
Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_nurture.template_brand.get --data @payload.json --json
topolo actions plan app_topolo_nurture.template_brand.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.template_brand.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_nurture.template_brand.get",
"input": {},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>"
}
}
Captured local response · HTTP 200:
{
"settings": {
"brandName": null,
"logoUrl": null,
"primaryColor": null,
"footerText": null,
"postalAddress": null,
"updatedAt": null
},
"brand": {
"sources": {
"brandName": "brand",
"logoUrl": "default",
"primaryColor": "default",
"footerText": "default",
"postalAddress": "default",
"logoAlt": "default",
"darkPrimaryColor": "default",
"legalEntityName": "default",
"unsubscribeText": "brand"
},
"brandName": "Kit Co",
"logoUrl": null,
"primaryColor": null,
"footerText": null,
"postalAddress": null,
"logoAlt": null,
"darkPrimaryColor": null,
"legalEntityName": null,
"unsubscribeText": "Opt out"
}
}
HTTP 200. Check $.brand.sources to see where each rendered value came from.
Verify the result
- Check $.brand.sources to see where each rendered value came from.
Errors and recovery
organization_required(HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.permission_denied(HTTP 403): Grant the credential the required Nurture workspace permission.workspace_required(HTTP 409): Create a Nurture workspace, or pass the workspace resource context.invalid_input(HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.
Recovery boundary
This action does not change service state.
Related actions
- Update template brand settings: Set the workspace fallback brand values email templates render with when no Brand kit supplies them: brandName, logoUrl (https), primaryColor (#RRGGBB), footerText and postalAddress. Send null to clear a value. Only the fields sent change.
Evidence
Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.