Skip to content
GitmoapAPIBeta
Planissue-blueprints
GET/groups/{group_id}/issue-blueprints

List a group's available custom types

list_group_blueprints
  • issue_blueprint:read
    A token needs the issue_blueprint:read scope: Read a scope's custom work-item types (blueprints)Granted by read_api, read_repository, write_api, write_repository.Every operation this scope unlocks
  • Single-resource

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

Returns the custom types the group defines, ordered by id. With include=inherited it adds those its parent groups define, nearest group first, and a type defined nearer the group hides one with the same id further up; each type says whether it is inherited. Anyone who can see the group's work items may list them — on a public group, without signing in.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID
Query
  • includestringoptionalSet to inherited to include ancestor-group blueprints

Responses

200The available custom types: the group's own first, then inherited onesapplication/json
  • base_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskThe built-in type the custom type is based on, which decides where its items may live, their children and their fields. "API Feature" might be a story with a blueprint on top.
  • blueprint_idBlueprintId (string)The blueprint's slug, unique within its group or repository. It never changes.
  • created_atstring
  • created_byActorSummaryWho created the blueprint, as they were when they created it.
  • inheritedbooleantrue when the blueprint is defined on an ancestor group rather than on the queried scope.
  • namestringThe custom type's display name, such as "API Feature".
  • scope_idstring
  • scope_typeScopeTypegrouprepository
  • updated_atstring
  • archivedbooleanoptionalHidden from the type picker; items already filed keep their type_profile.
  • descriptionstring or nulloptional
  • facetsarray of FacetTemplateoptionalThe blueprint's facets, in order.
    • The FacetTemplate schema
    • categoryFacetCategory (string)The facet's category — any value you choose. Facets with the same category are grouped together.
    • keyFacetKey (string)The facet's identifier within the blueprint. It stays the same when the label changes, so a work item re-applying the blueprint updates the facet in place.
    • labelstringThe facet's display name, such as "Observability".
    • bindingFacetBindingTemplateoptionalHow the seeded criterion is bound. Defaults to a manual checkbox.
    • hintstring or nulloptionalThe starter criterion's text. When absent the criterion is titled by the facet label.
    • requiredbooleanoptionalWhether the facet's criterion must be satisfied before the work item can be closed or verified. Defaults to true.
  • versioninteger · int64optional0–∞The blueprint's revision, incremented on every change. An update must send the version it read, and is refused with a 409 if the blueprint changed since.
200 exampleSynthesized example
[
{
"base_type": "epic",
"blueprint_id": "04dd41fb-9d77-4ef2-a89a-53fc3b569ecc",
"created_at": "2026-10-17T06:03:45Z",
"created_by": {
"email": "lin@acme.example",
"id": "id-ac7b",
"username": "mara"
},
"inherited": false,
"name": "payments-api",
"scope_id": "ed03b711-e868-49ef-8524-b68bd0a7472e",
"scope_type": "group",
"updated_at": "2026-10-11T20:55:01Z"
},
{
"base_type": "epic",
"blueprint_id": "a3091843-2a93-49a8-ad27-5d9e157cac23",
"created_at": "2026-10-11T09:18:36Z",
"created_by": {
"email": "mara@acme.example",
"id": "id-0e81",
"username": "tomas"
},
"inherited": false,
"name": "payments-api",
"scope_id": "68bfc224-242e-4933-9ac1-6785425664a7",
"scope_type": "group",
"updated_at": "2026-10-10T00:22:35Z"
}
]
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-ef2f",
"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-1290",
"message": "Inline scalar newtypes but keep their brand"
}
}
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-ac31",
"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-51c1",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap issue-blueprints list-group-blueprints

  • --group-ididGroup ID (id or group path)
  • --includestringoptionalSet to `inherited` to include ancestor-group blueprints

Used in these guides