Skip to content
GitmoapAPIBeta
Knowledgewiki
GET/groups/{group_id}/wiki

Read a group's wiki settings

get_group_wiki
  • wiki:read
    A token needs the wiki:read scope: Read wiki pages, their history and their backlinksGranted by mcp_agent, mcp_agent_write, read_api, write_api.Every operation this scope unlocks

Answers whether the wiki is enabled, its home page, how many pages it holds and its latest commit. A group that has never enabled a wiki answers enabled: false rather than 404. Anyone who can see the group may read its wiki; on a public group that includes callers who are not signed in.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID

Responses

200The wiki. A scope that has never enabled one answers `enabled: false` rather than 404 — whether a wiki exists is not a secretapplication/json
  • created_atstring
  • default_pageWikiPagePath (string)The page served at the wiki's root.
  • enabledbooleanWhether the wiki is on. A disabled wiki is `false` here, never a `404`: whether a wiki exists is not a secret, and only its contents are.
  • page_countinteger · int32How many pages the wiki has.
  • scope_idstring
  • scope_typeScopeTypegrouprepository
  • sourceWikiSourcededicatedin_repoWhere a wiki's pages come from.
  • updated_atstring
  • wiki_idWikiId (string · uuid)
  • clone_urlstring or nulloptionalWhere this wiki can be cloned from. Absent when the wiki has no clone URL of its own, as for a wiki that reads its pages from a repository.
  • created_byActorSummary or nulloptional
  • head_shaCommitHash (string) or nulloptionalThe commit the index was last built from. Absent until the first sync.
  • indexed_atstring or nulloptional
  • source_pathRepoPath (string) or nulloptionalThe directory a in_repo wiki reads from. Absent for a dedicated one.
200 exampleSynthesized example
{
"created_at": "2026-10-10T22:42:19Z",
"default_page": "default-page-4f24",
"enabled": true,
"page_count": 6,
"scope_id": "f12286da-4cdc-4ee9-a80e-68d5931e821e",
"scope_type": "group",
"source": "dedicated",
"updated_at": "2026-10-13T11:03:01Z",
"wiki_id": "79b7ee7a-59bd-40ac-a96e-995836547f58",
"clone_url": "https://gitmoap.example/acme/9b80cdc9",
"created_by": {
"email": "lin@acme.example",
"id": "id-da4e",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/7636ee89"
},
"head_sha": "1c2da9271ba8e70a7ddedcd6fa0e74505fcae334",
"indexed_at": "2026-10-13T10:28:15Z",
"source_path": "source-path-1b16"
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-ea41",
"message": "Draw the region map from operation density"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-f98f",
"message": "Pin a page's payload to the build that rendered it"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-a248",
"message": "Label every synthesized example"
}
}
404No such scope, or it is not visible to the callerapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-9dc9",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap wiki get-group-wiki

  • --group-ididGroup ID (id or group path)