Label Key Registry

List all registered label key definitions, optionally filtered by namespace

{
  "data": [
    {
      "key": "role.coordinator",
      "namespace": "role",
      "constant_name": "LabelKeys.roleCoordinator",
      "description": "Display name for the Coordinator role",
      "is_dynamic": false
    },
    {
      "key": "role.peer_mentor",
      "namespace": "role",
      "constant_name": "LabelKeys.rolePeerMentor",
      "description": "Display name for the Peer Mentor role",
      "is_dynamic": false
    },
    {
      "key": "activity_type.{type}",
      "namespace": "activity_type",
      "constant_name": "LabelKeys.activityTypePrefix",
      "description": "Dynamic key for activity type labels",
      "is_dynamic": true,
      "param": "type"
    },
    {
      "key": "report.{field}",
      "namespace": "report",
      "constant_name": "LabelKeys.reportField",
      "description": "Dynamic key for report field labels",
      "is_dynamic": true,
      "param": "field"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 26
  }
}

Get metadata for a specific registered label key

{
  "key": "role.coordinator",
  "namespace": "role",
  "constant_name": "LabelKeys.roleCoordinator",
  "description": "Display name for the Coordinator role",
  "is_dynamic": false,
  "used_in_components": [
    "organization-labels-notifier",
    "wcag-semantics-label-resolver"
  ]
}

Register a new label key definition in the registry

{
  "key": "role.volunteer_lead",
  "namespace": "role",
  "constant_name": "LabelKeys.roleVolunteerLead",
  "description": "Display name for the Volunteer Lead role",
  "is_dynamic": false,
  "default_value": "Volunteer Lead"
}

{
  "key": "role.volunteer_lead",
  "namespace": "role",
  "constant_name": "LabelKeys.roleVolunteerLead",
  "is_dynamic": false,
  "created_at": "2026-03-26T09:50:00.000Z"
}

Update metadata or description for a registered label key

{
  "description": "Display name for the Volunteer Lead / Group Lead role",
  "default_value": "Group Lead"
}

{
  "key": "role.volunteer_lead",
  "description": "Display name for the Volunteer Lead / Group Lead role",
  "default_value": "Group Lead",
  "updated_at": "2026-03-26T09:52:00.000Z"
}

Remove a label key definition from the registry

{
  "key": "role.volunteer_lead",
  "deleted": true,
  "affected_organizations": 0
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}