Skip to content
GitmoapAPIBeta
Knowledgespecs
GET/groups/{group_id}/specs

List indexed spec documents across a group's subtree

list_group_spec_docs
  • tree:read
    A token needs the tree:read scope: Browse repository trees and blobsGranted by mcp_agent, mcp_agent_write, read_api, read_repository, write_api, write_repository.Every operation this scope unlocks
  • Filtered across resources

    x-gitmoap-isolation: {"kind":"cross_resource_filtered"}

  • Paginated
    Pass the next_token a page returns to get the next one.

Documents from every repository in the group and its subgroups that you can see; a repository you cannot see contributes nothing and never shortens a page. Takes the same filters as a repository's document listing, and refuses an unknown filter value with 400. Paginated with limit (20 by default, at most 100) and next_token. Anyone who can see the group may call it; on a public group that includes callers who are not signed in.

Parameters

Path
  • group_idGroupId (string · uuid)The group whose subtree is rolled up
Query
  • kindstringoptionalFilter by document kind
  • statusstringoptionalFilter by declared status
  • posturestringoptionalFilter by conformance posture
  • profilestringoptionalFilter by the profile that read the document
  • owner_group_idstringoptionalFilter by the group the frontmatter names as owner
  • stalebooleanoptionalFilter by whether the latest indexing reached the document
  • include_orphanedbooleanoptionalInclude documents whose file has disappeared
  • searchstringoptionalMatch the title, summary or a doc_id substring
  • limitinteger · int32optionalPage size (1-100, default 20)
  • next_tokenstringoptionalPagination cursor

Responses

200Documents from every repository in the subtree the caller may seeapplication/json
  • itemsarray of object
    • block_countinteger · int32
    • byte_leninteger · int32
    • corpus_idCorpusId (string · uuid)
    • doc_idstring
    • finding_countinteger · int32
    • last_seen_shastring
    • pathstring
    • postureSpecPosturedeclareduntypedWhether a document claims to follow the spec format. A declared document carries gsf: 1 in its frontmatter and is checked in full; an untyped one made no claim and is never reported for not following it.
    • profilestring
    • record_countinteger · int32
    • staleboolean
    • stemstring
    • synced_atstring
    • titlestring
    • createdstring or nulloptional
    • depends_onarray of stringoptional
    • gsf_versioninteger · int32 or nulloptional
    • kindstring or nulloptional
    • last_reviewedstring or nulloptionalISO YYYY-MM-DD, verbatim from the frontmatter.
    • orphaned_atstring or nulloptionalWhen the file stopped being present in the repository. The record is kept rather than deleted, so an existing link still resolves and tells you it moved.
    • owner_group_idGroupId (string · uuid) or nulloptional
    • owner_principal_idPrincipalId (string · uuid) or nulloptional
    • parent_doc_idstring or nulloptional
    • part_of_doc_idstring or nulloptional
    • statusSpecStatusdraftreviewapprovedimplementedpartialsupersededlivingnoneor nulloptionalA document's declared lifecycle state. none is a real value rather than an absence: a document that declares status: none has said the question does not apply to it, which is a different fact from one that declared nothing.
    • status_notestring or nulloptional
    • summarystring or nulloptional
    • superseded_bystring or nulloptional
    • tagsarray of stringoptional
  • next_tokenstring or nulloptional
200 exampleSynthesized example
{
"items": [
{
"block_count": 6,
"byte_len": 1,
"corpus_id": "9040c62a-c0d0-49a6-b418-b812d96fedbf",
"doc_id": "c81adf4b-feb1-4b80-8615-1220a592e28d",
"finding_count": 5,
"last_seen_sha": "26df8ca3fb642002a2417d22d9cb3f7a53c2ca95",
"path": "path-b1be",
"posture": "declared",
"profile": "profile-3e99",
"record_count": 1,
"stale": false,
"stem": "stem-cce3",
"synced_at": "2026-10-10T12:20:48Z",
"title": "Inline scalar newtypes but keep their brand"
}
],
"next_token": "next-token-debe"
}
400Unknown filter value or malformed cursorapplication/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-8297",
"message": "Label every synthesized example"
}
}
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-e487",
"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-bced",
"message": "Inline scalar newtypes but keep their brand"
}
}
404Not found — or found and private, which is masked as absentapplication/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-f2e4",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap specs list-group-spec-docs

  • --group-ididThe group whose subtree is rolled up (id or group path)
  • --include-orphanedflagoptionalInclude documents whose file has disappeared
  • --kindstringoptionalFilter by document kind
  • --limitnumberoptionalPage size (1-100, default 20)
  • --next-tokenstringoptionalPagination cursor
  • --owner-group-idstringoptionalFilter by the group the frontmatter names as owner
  • --posturestringoptionalFilter by conformance posture
  • --profilestringoptionalFilter by the profile that read the document
  • --searchstringoptionalMatch the title, summary or a doc_id substring
  • --staleflagoptionalFilter by whether the latest indexing reached the document
  • --statusstringoptionalFilter by declared status

Used in these guides