Skip to content
GitmoapAPIBeta
Schema

TeamGrant

One grant a team holds.

Shape

  • atAccessScopeWhere the grant was made. It reaches there and everything beneath that inherits access.
  • created_atstring · date-time
  • grant_idGrantId (string · uuid)
  • roleRoleView
    • The RoleView schema
    • namestringThe role's display name: a built-in name such as Developer, or the custom role's name.
    • rankAccessLevelguestreporterdevelopermaintainerownerThe built-in rank the role counts as wherever a rank is compared, such as a protected branch's minimum.
    • builtinAccessLevelguestreporterdevelopermaintainerowneror nulloptionalSet when the role is built in.
    • customRoleId (string · uuid) or nulloptionalSet when the role is one the organization defined.
  • expires_atstring · date-time or nulloptional
  • granted_byActorSummary or nulloptional
  • reasonstring or nulloptional

Example

Synthesized example
{
"at": {
"full_path": "acme/payments-api",
"id": "id-a88e",
"type": "group"
},
"created_at": "2026-10-13T14:40:14Z",
"grant_id": "eb185151-0f61-4fd7-b626-5e3bf1beeb24",
"role": {
"name": "payments-api",
"rank": "guest",
"builtin": "guest",
"custom": "0fcd230f-7d36-4010-9099-aa509a80b7fa"
},
"expires_at": "2026-10-13T06:37:02Z",
"granted_by": {
"email": "mara@acme.example",
"id": "id-88e9",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/564867dc"
},
"reason": "reason-2917"
}

Graph

Used by

Sent by 0 operations

No operation takes it as a request body.