Get the job board

Read the job board’s publication state, active public URL and resolved appearance.

Outcome

Read the job board’s publication state, active public URL and resolved appearance.

Inspect the slug, company title, intro, publication flag, embed HTML and open-role count. Only open roles are listed publicly.
publicUrl can be null. When destination.kind is web_site and destinationActive is true, publicUrl points at the bound site’s origin plus basePath. Otherwise inspect the returned hosted/custom-domain URL fields; an inactive stored destination does not activate that route. Use the returned URL and separately verify the intended page rather than assuming or constructing an address.
appearance holds board settings, brand describes the available Brand values, and effectiveAppearance describes what the public pages should render.

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.job_board.get --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/job-board

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 job board configuration without changing state.

Interpret the response

Inspect $.board.publicUrl as returned; it can be null. When $.board.destination.kind is web_site and $.board.destinationActive is true, check the returned URL against the bound site origin plus basePath. An inactive stored destination does not activate that route. Verify $.board.published and $.board.effectiveAppearance separately, and verify the intended page independently; an API response alone does not prove page deployment or availability.

The job board uses the verified workspace. A nullable slug is a public address, not a canonical Topolo resource identifier.

Exact success schema:

{
  "type": "object",
  "required": [
    "board"
  ],
  "properties": {
    "board": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The board's stable id (board_…): the {boardId} of the public careers API and the id of its recruit.board reference. Null until the board is first saved."
        },
        "slug": {
          "type": [
            "string",
            "null"
          ]
        },
        "title": {
          "type": [
            "string",
            "null"
          ]
        },
        "intro": {
          "type": [
            "string",
            "null"
          ]
        },
        "published": {
          "type": "boolean"
        },
        "publicUrl": {
          "type": [
            "string",
            "null"
          ]
        },
        "customDomain": {
          "type": [
            "string",
            "null"
          ]
        },
        "embedHtml": {
          "type": [
            "string",
            "null"
          ]
        },
        "openRoleCount": {
          "type": "integer"
        },
        "appearance": {
          "type": "object",
          "description": "The board's own appearance settings. A null field is not set: Brand's value applies when source is brand, else the neutral default.",
          "properties": {
            "source": {
              "enum": [
                "brand",
                "manual"
              ],
              "description": "brand: follow the organization's published Brand presentation (logo, light and dark palettes, name) for every field the board does not set. manual: use only these settings and the neutral defaults."
            },
            "logoUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "primaryColor": {
              "type": [
                "string",
                "null"
              ],
              "description": "#rrggbb"
            },
            "coverImageUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "headline": {
              "type": [
                "string",
                "null"
              ]
            },
            "font": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "system",
                "grotesk",
                "serif",
                "rounded",
                null
              ]
            },
            "themeMode": {
              "enum": [
                "light",
                "dark",
                "auto"
              ],
              "description": "light (the default) or dark renders only that palette; auto follows the visitor's device setting. A board saved before this field existed reads as light."
            },
            "headerLinks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "label": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  }
                }
              }
            },
            "siteUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "footerLinks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "label": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  }
                }
              }
            },
            "showPoweredBy": {
              "type": "boolean"
            },
            "logoReversedUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "heroVariant": {
              "enum": [
                "text",
                "image"
              ]
            },
            "subheadline": {
              "type": [
                "string",
                "null"
              ]
            },
            "cover": {
              "type": [
                "object",
                "null"
              ],
              "description": "The hero image: url, alt (required), focalX and focalY (0-100)."
            },
            "sections": {
              "type": "object",
              "description": "about { enabled, body }, whyJoin { enabled, items }, benefits { enabled, items }, gallery { enabled, images }, hiringProcess { enabled, steps }, always in that order."
            },
            "rolesList": {
              "type": "object",
              "properties": {
                "groupBy": {
                  "enum": [
                    "none",
                    "team",
                    "location"
                  ]
                },
                "filters": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "sort": {
                  "enum": [
                    "newest",
                    "title"
                  ]
                }
              }
            },
            "confirmationMessage": {
              "type": [
                "string",
                "null"
              ]
            },
            "seo": {
              "type": "object",
              "properties": {
                "metaTitle": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "metaDescription": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "shareImage": {
                  "type": [
                    "object",
                    "null"
                  ]
                }
              }
            }
          }
        },
        "draftAppearance": {
          "type": [
            "object",
            "null"
          ],
          "description": "The unpublished next appearance (job_board.draft.update), the same shape as appearance; null without unpublished changes."
        },
        "destination": {
          "type": "object",
          "description": "Where the board's pages are stored to live. hosted (default): Recruit serves them at publicUrl. web_site: a Topolo Web site renders the board natively at origin + basePath; while destinationActive, publicUrl, canonicals, JobPosting url and role links point there, Recruit's hosted board and role pages answer 301 to it, and the public apply endpoint accepts applications only from origin.",
          "properties": {
            "kind": {
              "enum": [
                "hosted",
                "web_site"
              ]
            },
            "siteId": {
              "type": "string"
            },
            "origin": {
              "type": "string"
            },
            "basePath": {
              "type": "string"
            },
            "boundAt": {
              "type": "string"
            },
            "boundBy": {
              "type": "string"
            }
          }
        },
        "destinationActive": {
          "type": "boolean",
          "description": "Whether the stored destination is honoured in this environment (RECRUIT_CAREERS_DESTINATIONS on). False for a hosted board; a stored web_site destination that is not active changes nothing until it is."
        },
        "destinationHistory": {
          "type": "array",
          "description": "The latest destination changes, newest first (up to 5): bind or unbind, who, and the site, origin and basePath before and after.",
          "items": {
            "type": "object",
            "properties": {
              "action": {
                "enum": [
                  "bind",
                  "unbind"
                ]
              },
              "actorUserId": {
                "type": "string"
              },
              "siteId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "origin": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "basePath": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "previousSiteId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "previousOrigin": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "previousBasePath": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "createdAt": {
                "type": "string"
              }
            }
          }
        },
        "brand": {
          "type": "object",
          "description": "What Brand offers this board: status available (a published kit applies), none (nothing is published for the workspace), unavailable (Brand did not answer and nothing is cached) or unconfigured (Brand is not set up in this environment).",
          "properties": {
            "status": {
              "enum": [
                "available",
                "none",
                "unavailable",
                "unconfigured"
              ]
            },
            "name": {
              "type": [
                "string",
                "null"
              ]
            },
            "logoUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "primaryColor": {
              "type": [
                "string",
                "null"
              ]
            },
            "darkPrimaryColor": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        },
        "effectiveAppearance": {
          "type": "object",
          "description": "What the public pages render now: the board's settings over Brand (when followed) over the neutral defaults. brand says whether Brand was applied, not_followed (manual), none or unavailable.",
          "properties": {
            "name": {
              "type": "string"
            },
            "logoUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "headline": {
              "type": [
                "string",
                "null"
              ]
            },
            "primaryLight": {
              "type": "string"
            },
            "primaryDark": {
              "type": "string"
            },
            "font": {
              "enum": [
                "system",
                "grotesk",
                "serif",
                "rounded",
                "brand"
              ]
            },
            "themeMode": {
              "enum": [
                "light",
                "dark",
                "auto"
              ]
            },
            "logoReversedUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "markUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "markReversedUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "heroVariant": {
              "enum": [
                "text",
                "image"
              ]
            },
            "headerLinks": {
              "type": "array",
              "items": {
                "type": "object"
              }
            },
            "siteUrl": {
              "type": [
                "string",
                "null"
              ]
            },
            "footerLinks": {
              "type": "array",
              "items": {
                "type": "object"
              }
            },
            "showPoweredBy": {
              "type": "boolean"
            },
            "brand": {
              "enum": [
                "applied",
                "not_followed",
                "none",
                "unavailable"
              ]
            }
          }
        }
      }
    }
  }
}

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.job_board.get --data @payload.json --json
topolo actions plan app_topolo_recruit.job_board.get --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.job_board.get --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.job_board.get",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "board": {
    "id": null,
    "slug": null,
    "title": null,
    "intro": null,
    "published": false,
    "appearance": {
      "source": "brand",
      "logoUrl": null,
      "primaryColor": null,
      "coverImageUrl": null,
      "headline": null,
      "font": null,
      "footerLinks": [],
      "showPoweredBy": true
    },
    "destination": {
      "kind": "hosted"
    },
    "publicUrl": null,
    "customDomain": null,
    "embedHtml": null,
    "openRoleCount": 0,
    "brand": {
      "status": "unconfigured",
      "name": null,
      "logoUrl": null,
      "primaryColor": null,
      "darkPrimaryColor": null
    },
    "effectiveAppearance": {
      "name": "",
      "logoUrl": null,
      "coverImageUrl": null,
      "headline": null,
      "primaryLight": "#0a76a9",
      "primaryDark": "#0a76a9",
      "font": "system",
      "footerLinks": [],
      "showPoweredBy": true,
      "brand": "none"
    },
    "destinationActive": false,
    "destinationHistory": []
  }
}

HTTP 200. Inspect $.board.publicUrl as returned; it can be null. When $.board.destination.kind is web_site and $.board.destinationActive is true, check the returned URL against the bound site origin plus basePath. An inactive stored destination does not activate that route. Verify $.board.published and $.board.effectiveAppearance separately, and verify the intended page independently; an API response alone does not prove page deployment or availability.

Another supported request

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_recruit.job_board.get --data @payload.json --json
topolo actions plan app_topolo_recruit.job_board.get --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.job_board.get --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.job_board.get",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "board": {
    "id": "board_00fa2973d662415e8d4b8203bb5cff05",
    "slug": "acme",
    "title": null,
    "intro": null,
    "published": false,
    "appearance": {
      "source": "brand",
      "logoUrl": null,
      "primaryColor": null,
      "coverImageUrl": null,
      "headline": null,
      "font": null,
      "footerLinks": [],
      "showPoweredBy": true
    },
    "destination": {
      "kind": "hosted"
    },
    "publicUrl": null,
    "customDomain": null,
    "embedHtml": null,
    "openRoleCount": 0,
    "brand": {
      "status": "unconfigured",
      "name": null,
      "logoUrl": null,
      "primaryColor": null,
      "darkPrimaryColor": null
    },
    "effectiveAppearance": {
      "name": "",
      "logoUrl": null,
      "coverImageUrl": null,
      "headline": null,
      "primaryLight": "#0a76a9",
      "primaryDark": "#0a76a9",
      "font": "system",
      "footerLinks": [],
      "showPoweredBy": true,
      "brand": "none"
    },
    "destinationActive": false,
    "destinationHistory": []
  }
}

Verify the result

Inspect $.board.publicUrl as returned; it can be null. When $.board.destination.kind is web_site and $.board.destinationActive is true, check the returned URL against the bound site origin plus basePath. An inactive stored destination does not activate that route. Verify $.board.published and $.board.effectiveAppearance separately, and verify the intended page independently; an API response alone does not prove page deployment or availability.

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): Inspect the required Recruit permission and the credential’s granted workspace access. Use an already authorized credential/scope or request the missing access from its owner. Change credentials or grants only under separate explicit authorization; do not expand permissions automatically to clear this refusal.
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): Use a key explicitly bound to the intended granted workspace. Inspect Auth api_keys.options before creating or changing a key, and obtain approval for any credential or access change; do not widen bindings automatically.
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): The required workspace permission is workspace:read for reads or workspace:write for changes, including deletion. Inspect the authorized key options and resource access; request any missing access from its owner rather than granting it automatically.

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.

Update the job board: Update the job board’s live address, company text and appearance.
Publish the job board: Make the job board public at its publicUrl. Only roles with status open appear on it; closing a role removes it immediately. Requires a slug and title. Applicants are anonymous, so an application never changes an existing candidate: one that uses an existing candidate's email becomes a new candidate flagged duplicateOf them (merge with candidates.merge), and a repeat application to the same role is only noted on the existing application's timeline. The applicant sees the same confirmation either way. 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

Updated the precise board response and worked examples for appearance, Brand resolution, custom-domain URLs and destination state.
Updated this guide from source revision 63171ed7c08aa066adb44cc01e64011e465302e1; retained 2 source-captured request/response examples and their simulated-dependency limitations.
Clarified authorized API-key/resource recovery without automatic permission expansion. This documentation update does not establish deployment, live hiring operations or notification delivery.