Skip to content
GitmoapAPIBeta
Schema

CustomRole

A custom role of an organization.

Shape

  • addedarray of stringPermissions added to the base, by key.
  • base_roleAccessLevelguestreporterdevelopermaintainerownerThe built-in role this one starts from, and whose rank it counts as wherever a rank is compared, such as a protected branch's minimum.
  • created_atstring · date-time
  • descriptionstring
  • namestring
  • organization_idGroupId (string · uuid)The organization's top-level group.
  • permissionsarray of stringEverything the role holds: the base, the additions and what they need, less the removals.
  • removedarray of stringPermissions removed from the base, by key.
  • role_idRoleId (string · uuid)
  • slugEntityName (string)
  • updated_atstring · date-time
  • created_byActorSummary or nulloptional

Example

Synthesized example
{
"added": [
"added-e537"
],
"base_role": "guest",
"created_at": "2026-10-14T00:32:19Z",
"description": "Renders each region as density contours of its operations.",
"name": "payments-api",
"organization_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"permissions": [
"permissions-0f68"
],
"removed": [
"removed-2ab8"
],
"role_id": "5054b45a-a491-4823-aeb5-5180143b822b",
"slug": "slug-1c49",
"updated_at": "2026-10-14T11:52:39Z",
"created_by": {
"email": "mara@acme.example",
"id": "id-629d",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/f864fc9f"
}
}

Graph

Used inside
Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 3 operations