Get invoice email settings

Read the effective invoice From and Reply-To, the workspace sender and organization sending domains.

Outcome

Read the effective invoice From and Reply-To, the workspace sender and organization sending domains.

Before you start

Verify the intended environment, authenticated identity and specifically approved organization context.
The published application permission is settings:read. Discover the exact granted canonical Books workspace and bind it separately from action input.

Discover the target

topolo whoami --json
topolo actions get app_topolo_books.settings.invoice_email.get --detail --json
topolo resources topolo-books --json
topolo workspaces list topolo-books --json

Set BOOKS_WORKSPACE_ID to the exact granted workspace returned by discovery.

Request

GET /api/settings/invoice-email

Inspect and test this action. Save the reviewed input as payload.json; supply credential/resource context separately.

Input fields

Use an empty input object. Credential and resource context are separate.

Inspect nested fields and the complete input schema.

Effects

Reads this workspace sender and organization domain readiness.

Interpret the response

Read $.workspaceId for the returned workspace identifier. Empty collections and nullable fields do not discover a target.

Confirm sender.from, sender.replyTo and workspaceSender describe the effective identity.

Inspect the success schema. CLI/MCP add their own transport envelope; CLI --detail requests the full result.

Worked examples

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.

Run a reviewed request

Save the input from the selected worked example as payload.json. Validate and inspect the plan before calling the action; refused examples demonstrate errors and are not instructions to execute.

CLI:

topolo actions validate app_topolo_books.settings.invoice_email.get --data @payload.json --json
topolo actions plan app_topolo_books.settings.invoice_email.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.settings.invoice_email.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --detail --json

MCP tool and arguments for the first successful example:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_books.settings.invoice_email.get",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Successful response · HTTP 200

Input · payload.json:

{}

Captured response · HTTP 200

{
  "workspaceId": "ws_documentation-email_muvnprk21",
  "sender": {
    "from": "Fixture Accounts <accounts@example.com>",
    "replyTo": null,
    "source": "workspace",
    "profileId": "fixture-profile"
  },
  "domains": [
    {
      "id": "fixture-domain",
      "sending_domain": "example.com",
      "is_active": true,
      "sendable": true,
      "verification_status": "verified",
      "verification_error": null,
      "dns_records": []
    }
  ],
  "workspaceSender": {
    "profile_name": "Books invoices · ws_documentation-email_muvnprk21",
    "from_name": "Fixture Accounts",
    "from_email": "accounts@example.com",
    "reply_to_email": null,
    "app_id": "app_topolo_books",
    "resource_type": "workspace",
    "resource_id": "ws_documentation-email_muvnprk21",
    "is_default": false,
    "connection_id": "fixture-domain",
    "id": "fixture-profile",
    "is_active": 1
  },
  "canManage": true
}

HTTP 200. Confirm sender.from, sender.replyTo and workspaceSender describe the effective identity.

Refused response · auth_error

Input · payload.json:

{}

Captured response · HTTP 401

{
  "error": "API key validation failed"
}

HTTP 401. SDK error code auth_error. Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

Verify the result

Confirm sender.from, sender.replyTo and workspaceSender describe the effective identity.

Errors and recovery

auth_error (HTTP 401): Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

These are observed local refusals. Shared authentication, schema validation and resource authorization can also refuse before the route. Preserve the actual error, details and request id.

Recovery boundary

Repeat a read in the same authorized context; no state is changed.

Get workspace settings: Read the workspace accounting, invoice identity and invoice approval-automation settings.