Skip to content
GitmoapAPIBeta
Agentsai-org
GET/groups/{group_id}/ai-org/agents

The organization's agents, with their positions and squads.

list_ai_agents
  • ai_org:read
    A token needs the ai_org:read scope: Read an AI organization, its agents, sessions and usageGranted by read_api, write_api.Every operation this scope unlocks
  • Single-resource

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

Readable by anyone who can view the AI organization.

Parameters

Path
  • group_idGroupId (string · uuid)The organization's top-level group

Responses

200The agents, by handleapplication/json
  • itemsarray of AiAgent
    • The AiAgent schema
    • agent_idAgentId (string · uuid)
    • agent_keyAgentKey (string)
    • created_atstring · date-time
    • created_byActorSummaryThe person on whose behalf the platform hired it.
    • display_nameAgentDisplayName (string)
    • emailstringThe no-reply address its commits are authored as.
    • handleAgentHandle (string)
    • hired_revisioninteger · int64
    • org_idAiOrgId (string · uuid)
    • root_group_idGroupId (string · uuid)The top-level group whose organization it works in.
    • stateAgentStateactivedrainingretired
    • current_session_idAiSessionId (string · uuid) or nulloptionalThe session it is running now, if any.
    • positionPositionengineerreviewerproduct_ownerdirectorrelease_managertechnical_writeror nulloptionalIts position, from the live revision; absent once retired.
    • retired_atstring · date-time or nulloptional
    • retired_revisioninteger · int64 or nulloptional
    • squadSquadKey (string) or nulloptionalIts squad, from the live revision; absent once retired.
    • suspended_atstring · date-time or nulloptional
    • suspended_byActorSummary or nulloptional
200 exampleSynthesized example
{
"items": [
{
"agent_id": "82cf81d1-ae8c-4ae6-9fe6-a9950a053ded",
"agent_key": "agent-key-81f0",
"created_at": "2026-10-14T19:42:51Z",
"created_by": {
"email": "mara@acme.example",
"id": "id-d7eb",
"username": "mara"
},
"display_name": "Tomás Reyes",
"email": "mara@acme.example",
"handle": "handle-9026",
"hired_revision": 35,
"org_id": "a9d3add2-ab5d-4a3c-a772-290392ed4083",
"root_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"state": "active"
},
{
"agent_id": "54524ce6-de8d-43aa-b59c-8267f49b28c9",
"agent_key": "agent-key-2cf9",
"created_at": "2026-10-16T11:13:41Z",
"created_by": {
"email": "mara@acme.example",
"id": "id-1eb1",
"username": "tomas"
},
"display_name": "Lin Park",
"email": "tomas@acme.example",
"handle": "handle-7b48",
"hired_revision": 2,
"org_id": "019a6cfc-de1f-44bd-ab30-59f533342268",
"root_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"state": "active"
}
]
}
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-2e79",
"message": "Pin a page's payload to the build that rendered it"
}
}
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-5537",
"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-49bc",
"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-aeb6",
"message": "Pin a page's payload to the build that rendered it"
}
}

CLI

gitmoap ai-org list-ai-agents

  • --group-ididThe organization's top-level group (id or group path)