Skip to content
GitmoapAPIBeta
Planissues
GET/groups/{group_id}/issue-settings

Get the issue settings a group declares

get_group_issue_settings
  • issue_settings:read
    A token needs the issue_settings:read scope: Read effective issue settingsGranted by read_api, read_repository, write_api, write_repository.Every operation this scope unlocks

Returns only what the group itself sets — nothing is resolved from the groups above it and no defaults are filled in, so a field the group does not set comes back unset. Anyone who can see the group's work items may read them — on a public group, without signing in.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID

Responses

200What this group stores, unresolvedapplication/json
  • anchor_drift_actionAnchorDriftActionflagcommentnoneor nulloptionalWhat happens when an anchored region of code changes beyond recognition.
  • auto_close_on_verifiedboolean or nulloptional
  • auto_reopen_on_orphaned_closeboolean or nulloptional
  • auto_reopen_on_regressionboolean or nulloptional
  • binding_change_resets_evidenceboolean or nulloptional
  • blocked_by_blocks_closeboolean or nulloptional
  • close_on_commit_keywordboolean or nulloptional
  • closing_branchesarray of BranchPattern (string) or nulloptional
  • default_assignee_from_codeownersboolean or nulloptional
  • default_issue_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskor nulloptionalThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
  • on_branch_createdAutoTransition or nulloptional
  • on_mr_closedAutoTransition or nulloptional
  • on_mr_mergedAutoTransition or nulloptional
  • on_mr_openedAutoTransition or nulloptional
  • override_group_settingsboolean or nulloptional
  • public_issue_filingboolean or nulloptional
  • require_verified_criteria_to_closeboolean or nulloptional
  • statusesarray of StatusDef or nulloptional
    • The StatusDef schema
    • categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe category this status belongs to. It cannot be changed after the status is created: to move work to a different category, add a status and archive this one.
    • namestring
    • status_idStatusId (string)
    • archivedbooleanoptional
    • colorLabelColor (string) or nulloptional
    • is_defaultbooleanoptionalThe status new issues land in. Exactly one status in a set carries it, and it must be open.
  • todo_ignore_pathsarray of string or nulloptional
  • todo_policyTodoPolicyignoreindexpromoteor nulloptionalWhat a bare // TODO: in a push becomes.
  • todo_promote_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskor nulloptionalThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
  • transitionsTransitionTable or nulloptional
200 exampleSynthesized example
{
"anchor_drift_action": "flag",
"auto_close_on_verified": false,
"auto_reopen_on_orphaned_close": false,
"auto_reopen_on_regression": false,
"binding_change_resets_evidence": false,
"blocked_by_blocks_close": false,
"close_on_commit_keyword": false,
"closing_branches": [
"closing-branches-64c8",
"closing-branches-95f8"
],
"default_assignee_from_codeowners": false,
"default_issue_type": "epic",
"on_branch_created": "disabled",
"on_mr_closed": "disabled",
"on_mr_merged": "disabled",
"on_mr_opened": "disabled",
"override_group_settings": false,
"public_issue_filing": false,
"require_verified_criteria_to_close": false,
"statuses": [
{
"category": "triage",
"name": "payments-api",
"status_id": "0b6b547e-fcb3-49ec-9594-2db1e9c09455"
}
],
"todo_ignore_paths": [
"todo-ignore-paths-b7d1"
],
"todo_policy": "ignore",
"todo_promote_type": "epic",
"transitions": {
"table": {}
}
}
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-cda4",
"message": "Inline scalar newtypes but keep their brand"
}
}
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-6a2b",
"message": "Stream pipeline status into the run header"
}
}
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-ea7e",
"message": "Label every synthesized example"
}
}
404Group not foundapplication/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-a7ec",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap issues get-group-settings

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

Used in these guides