Outcome
List the job board's custom domain (a workspace has at most one) with its status — pending_dns (publish the records), pending_ssl (claimed; waiting for the certificate, edgeStatus, or the apply form's Turnstile widget, turnstileStatus) or active (the board is served at url) — and the DNS guide whose guide.records are the exact records to publish. edgeTarget is the CNAME target in this environment; null means custom domains are unavailable here. Recruiters only.
Before you start
- Verify identity and the pinned organization context, then discover the exact action and a granted Recruit workspace.
- The required application permission is workspace:read. Hiring-team roles and record visibility are enforced separately; a workspace grant alone does not grant every Recruit action.
- Organization and workspace identity come from verified context. Pass the workspace as resourceType/resourceId, separate from action input; request-body organizationId/workspaceId values cannot select an authorized scope.
- The first authorized action can initialize an identity-only workspace mirror and invoke the configured workspace-created callback. It does not create an Auth workspace or grant new access.
Recruiters can perform the full hiring workflow. Hiring managers see their managed roles and candidates; interviewers see assigned interviews and their candidates. Workspace owners and organization administrators act as recruiters. Use team.me to read the caller's effective role and allowed actions.
Discover the target
topolo whoami --json
topolo actions get app_topolo_recruit.domains.list --detail --json
topolo resources topolo-recruit --json
topolo workspaces list topolo-recruit --json
topolo actions get app_topolo_recruit.team.me --detail --json
Request
GET /api/domains
Save input as payload.json. CLI and MCP action input includes path identifiers. The reviewed plan separates path/query fields from the HTTP body. Set RECRUIT_WORKSPACE_ID from granted resource discovery.
Inspect and test this action in the signed action console. Use its discovered schema and plan; a test response still requires the verification described below.
Input fields
Use an empty JSON object as input; verified credential and workspace context are separate.
Exact input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}
Effects
- Reads the custom domain without changing state.
Interpret the response
Confirm each domain's status and that guide.records lists one routing and one ownership record.
The response identifier path is $.domains[].id for custom_domain. Lists may be empty; an empty list is not a discovered target.
Exact success schema:
{
"type": "object",
"required": [
"domains",
"edgeTarget"
],
"properties": {
"domains": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"hostname",
"status",
"guide"
],
"properties": {
"id": {
"type": "string"
},
"hostname": {
"type": "string"
},
"status": {
"enum": [
"pending_dns",
"pending_ssl",
"active"
]
},
"apex": {
"type": "boolean"
},
"dnsTarget": {
"type": "string"
},
"guide": {
"type": "object",
"required": [
"title",
"summary",
"steps",
"records",
"copyAllValue",
"safetyNote"
],
"description": "The registrar-level DNS instructions in the request's language: one routing and one ownership record to publish, with the steps and notes shown to people.",
"properties": {
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "string"
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"required": [
"purpose",
"type",
"host",
"name",
"value",
"instruction"
],
"properties": {
"purpose": {
"enum": [
"routing",
"ownership"
]
},
"type": {
"enum": [
"A",
"CNAME",
"TXT"
]
},
"host": {
"type": "string",
"description": "The name relative to the customer's zone, as most DNS hosts expect it (@ for the apex)."
},
"name": {
"type": "string",
"description": "The fully qualified record name."
},
"value": {
"type": "string"
},
"required": {
"type": "boolean"
},
"instruction": {
"type": "string",
"description": "What to publish, in the request's language."
},
"title": {
"type": "string"
},
"purposeLabel": {
"type": "string"
},
"hostLabel": {
"type": "string"
},
"valueLabel": {
"type": "string"
},
"hostHelp": {
"type": "string"
},
"valueHelp": {
"type": "string"
}
}
}
},
"copyAllLabel": {
"type": "string"
},
"copyAllValue": {
"type": "string",
"description": "Every record as tab-separated type, host and value lines."
},
"safetyNote": {
"type": "string"
},
"apexNote": {
"type": "string",
"description": "Present for an apex domain: the DNS host must support CNAME flattening, ALIAS or ANAME."
}
}
},
"url": {
"type": [
"string",
"null"
],
"description": "The address once the domain is active; null before."
},
"attached": {
"type": "boolean",
"description": "True once the hostname is claimed in Topolo Web's hostname registry."
},
"edgeStatus": {
"type": [
"string",
"null"
],
"enum": [
"pending_ssl",
"active",
null
],
"description": "The certificate, as the latest claim reported it; null before the first claim."
},
"turnstileStatus": {
"type": [
"string",
"null"
],
"enum": [
"pending",
"attached",
"failed",
null
],
"description": "The domain's own Turnstile widget, as the latest claim reported it; null before the first claim."
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"verifiedAt": {
"type": [
"string",
"null"
]
}
}
}
},
"edgeTarget": {
"type": [
"string",
"null"
]
}
}
}
Worked examples
Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. A synthetic fixture identifier grants no access. Validate and inspect the planned request before executing. Commands with --confirm or MCP confirm:true assume the intended effect or data export has already been authorized.
Successful request
Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This complete response is a local fixture, not a deployed or delivered result.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_recruit.domains.list --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_recruit.domains.list",
"input": {},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>"
}
}
Captured local response · HTTP 200:
{
"domains": [
{
"id": "dom_f6dc45dd47714adaaeafabf69ae8cc0f",
"hostname": "careers.example.com",
"status": "pending_dns",
"apex": false,
"dnsTarget": "jobs.topolo.app",
"guide": {
"title": "Connect careers.example.com",
"summary": "Open the DNS settings at the company where this domain is managed, then add the records below exactly as shown.",
"steps": [
"Open DNS settings for your domain.",
"Add each record below. If a matching record already exists, edit it instead of creating a duplicate.",
"Save your changes, return here, and select Verify DNS."
],
"records": [
{
"purpose": "routing",
"type": "CNAME",
"host": "careers",
"name": "careers.example.com",
"value": "jobs.topolo.app",
"required": true,
"instruction": "Publish a CNAME from careers to jobs.topolo.app. Leave MX, SPF, and DKIM records unchanged.",
"title": "1. Send visitors to Topolo",
"purposeLabel": "Website address",
"hostLabel": "Name / Host",
"valueLabel": "Points to / Value",
"hostHelp": "Enter careers in the Name or Host field.",
"valueHelp": "Paste jobs.topolo.app exactly, without quotes."
},
{
"purpose": "ownership",
"type": "TXT",
"host": "_topolo-verification.careers",
"name": "_topolo-verification.careers.example.com",
"value": "topolo-verification=d0bad20f42eb4f0981703fa341be2e40",
"required": true,
"instruction": "Publish a TXT record at _topolo-verification.careers.example.com with this exact value. Leave every other TXT record unchanged.",
"title": "2. Confirm you own the domain",
"purposeLabel": "Ownership check",
"hostLabel": "Name / Host",
"valueLabel": "TXT value",
"hostHelp": "Enter _topolo-verification.careers in the Name or Host field.",
"valueHelp": "Paste topolo-verification=d0bad20f42eb4f0981703fa341be2e40 exactly, without quotes."
}
],
"copyAllLabel": "Copy all records",
"copyAllValue": "CNAME\tcareers\tjobs.topolo.app\nTXT\t_topolo-verification.careers\ttopolo-verification=d0bad20f42eb4f0981703fa341be2e40",
"safetyNote": "Do not change MX, SPF, DKIM, or other email records. DNS changes can take a few minutes to appear."
},
"url": null,
"attached": false,
"edgeStatus": null,
"turnstileStatus": null,
"createdAt": "2026-10-05T09:00:00.000Z",
"updatedAt": "2026-10-05T09:00:00.000Z",
"verifiedAt": null
}
],
"edgeTarget": "jobs.topolo.app"
}
HTTP 200. Confirm each domain's status and that guide.records lists one routing and one ownership record.
Another supported request
Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This complete response is a local fixture, not a deployed or delivered result.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_recruit.domains.list --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_recruit.domains.list",
"input": {},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>"
}
}
Captured local response · HTTP 200:
{
"domains": [],
"edgeTarget": null
}
HTTP 200. Confirm each domain's status and that guide.records lists one routing and one ownership record.
Another supported request
Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This complete response is a local fixture, not a deployed or delivered result.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_recruit.domains.list --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_recruit.domains.list",
"input": {},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>"
}
}
Captured local response · HTTP 200:
{
"domains": [
{
"id": "dom_4be43d3d007d4b638de55ce93dacf914",
"hostname": "careers.example.com",
"status": "pending_dns",
"apex": false,
"dnsTarget": "jobs.topolo.app",
"guide": {
"title": "Connect careers.example.com",
"summary": "Open the DNS settings at the company where this domain is managed, then add the records below exactly as shown.",
"steps": [
"Open DNS settings for your domain.",
"Add each record below. If a matching record already exists, edit it instead of creating a duplicate.",
"Save your changes, return here, and select Verify DNS."
],
"records": [
{
"purpose": "routing",
"type": "CNAME",
"host": "careers",
"name": "careers.example.com",
"value": "jobs.topolo.app",
"required": true,
"instruction": "Publish a CNAME from careers to jobs.topolo.app. Leave MX, SPF, and DKIM records unchanged.",
"title": "1. Send visitors to Topolo",
"purposeLabel": "Website address",
"hostLabel": "Name / Host",
"valueLabel": "Points to / Value",
"hostHelp": "Enter careers in the Name or Host field.",
"valueHelp": "Paste jobs.topolo.app exactly, without quotes."
},
{
"purpose": "ownership",
"type": "TXT",
"host": "_topolo-verification.careers",
"name": "_topolo-verification.careers.example.com",
"value": "topolo-verification=dcd331e211744bcab18a135f8e30ed4b",
"required": true,
"instruction": "Publish a TXT record at _topolo-verification.careers.example.com with this exact value. Leave every other TXT record unchanged.",
"title": "2. Confirm you own the domain",
"purposeLabel": "Ownership check",
"hostLabel": "Name / Host",
"valueLabel": "TXT value",
"hostHelp": "Enter _topolo-verification.careers in the Name or Host field.",
"valueHelp": "Paste topolo-verification=dcd331e211744bcab18a135f8e30ed4b exactly, without quotes."
}
],
"copyAllLabel": "Copy all records",
"copyAllValue": "CNAME\tcareers\tjobs.topolo.app\nTXT\t_topolo-verification.careers\ttopolo-verification=dcd331e211744bcab18a135f8e30ed4b",
"safetyNote": "Do not change MX, SPF, DKIM, or other email records. DNS changes can take a few minutes to appear."
},
"url": null,
"attached": false,
"edgeStatus": null,
"turnstileStatus": null,
"createdAt": "2026-10-05T09:00:00.000Z",
"updatedAt": "2026-10-05T09:00:00.000Z",
"verifiedAt": null
}
],
"edgeTarget": "jobs.topolo.app"
}
HTTP 200. Confirm each domain's status and that guide.records lists one routing and one ownership record.
Another supported request
Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This complete response is a local fixture, not a deployed or delivered result.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_recruit.domains.list --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_recruit.domains.list",
"input": {},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>"
}
}
Captured local response · HTTP 200:
{
"domains": [],
"edgeTarget": "jobs.topolo.app"
}
HTTP 200. Confirm each domain's status and that guide.records lists one routing and one ownership record.
Refused request · hiring_team_role_required
Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This is a refused request; diagnose it before retrying.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_recruit.domains.list --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.list --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
Captured local response · HTTP 403:
{
"error": {
"code": "hiring_team_role_required",
"message": "Your hiring-team role in this workspace does not allow this action.",
"messageKey": "recruit.api.errors.teamRoleRequired",
"locale": "en",
"details": {
"teamRole": "hiring_manager",
"allowedRoles": [
"recruiter"
]
}
}
}
HTTP 403. Preserve the exact response code and details. Do not claim success.
Verify the result
- Confirm each domain's status and that guide.records lists one routing and one ownership record.
Errors and recovery
organization_context_required(HTTP 403): Select the organization authorized by the credential; do not send an organization id in the action input.permission_denied(HTTP 403): Grant the credential the required Recruit workspace permission.hiring_team_role_required(HTTP 403): Ask a recruiter to give the caller a hiring-team role that allows this action (team.members.set); error.details lists the allowed roles.workspace_required(HTTP 409): Create a Recruit workspace, or pass the workspace resource context.invalid_input(HTTP 422): Correct the fields named in error.details using inputSchema, then retry.api_key_workspace_binding_required(HTTP 403): Create the API key bound to a workspace (an organization-wide key names a workspace nobody verified), then call again.workspace_required(HTTP 400): Send the workspace the key is bound to with --resource-type workspace --resource-id <workspace id> (or the X-Topolo-Resource-Type and X-Topolo-Resource-Id headers).workspace_forbidden(HTTP 403): Use a workspace the key is bound to; read the key's bindings in API key management.workspace_access_insufficient(HTTP 403): Give the key the workspace permission this action needs: workspace:read to read and workspace:write to change. A delete also needs workspace:write, because the write permission is what grants the read_write level.
Authentication or gateway failures may occur before the Recruit handler. Preserve the exact discovered service error, request id and credential context. The local fixtures do not establish live credential authorization.
Recovery boundary
This action does not change service state.
Related actions
- Add a custom domain to the job board: Connect a hostname the organization owns (careers.example.com) to the public job board. Returns the DNS guide for the domain's DNS host, in the request's language; guide.records are the records to publish: a CNAME to the jobs edge host and a TXT ownership record; unrelated records (MX, SPF, DKIM) stay untouched. The domain starts as pending_dns and serves nothing until domains.verify succeeds. Apex domains need CNAME flattening, ALIAS or ANAME at the DNS host; otherwise use a subdomain. Reserved hosting-platform hostnames (Topolo platform zones, workers.dev, pages.dev) are refused with hostname_reserved; any other domain the organization owns can be connected. One custom domain per job board. Recruiters only.
- Verify and connect a custom domain: Check the domain's ownership TXT record on the public resolver, then claim the hostname in Topolo Web's hostname registry for this job board. Web routes the hostname to Recruit, creates its Cloudflare for SaaS custom hostname and attaches it to its own Turnstile widget; Recruit holds no Cloudflare credential. Status moves pending_dns → pending_ssl (claimed; certificate or Turnstile widget not ready) → active, which needs edgeStatus active and turnstileStatus attached. Call it again while pending_ssl: it repeats the claim to refresh both. An active domain is returned unchanged. Recruiters only.
Evidence
Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. Test capture provenance is retained with each fixture. API, database and integration outcomes require separate verification in the target environment.
Documentation history
- 2026-10-18: Added this action guide with reviewed request, response, permission, verification and recovery guidance from source
63171ed7c08aa066adb44cc01e64011e465302e1. Examples are retained local captures, not production execution or delivery proof.