Org Labels Provider
API Contract
REST
/api/v1/organization-labels
7 endpoints
GET
/api/v1/organization-labels/api/v1/organization-labels
List all label entries for the current organization — maps to getCurrentLabels()
Public
Response Example
{
"data": [
{
"key": "app.title",
"value": "Acme Portal"
},
{
"key": "nav.dashboard",
"value": "Dashboard"
},
{
"key": "nav.reports",
"value": "Reports"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 3
}
}
GET
/api/v1/organization-labels/api/v1/organization-labels/:key
Get a single label by key — maps to getLabel(key)
Public
Response Example
{
"key": "app.title",
"value": "Acme Portal"
}
POST
/api/v1/organization-labels/api/v1/organization-labels
Create a new label override for the organization
Public
Request Example
{
"organization_id": "org-abc123",
"key": "nav.reports",
"value": "Analytics"
}
Response Example
{
"key": "nav.reports",
"value": "Analytics",
"organization_id": "org-abc123",
"created_at": "2026-03-26T10:10:00Z"
}
PUT
/api/v1/organization-labels/api/v1/organization-labels/:key
Update an existing label value
Public
Request Example
{
"value": "Insights"
}
Response Example
{
"key": "nav.reports",
"value": "Insights",
"updated_at": "2026-03-26T10:12:00Z"
}
DELETE
/api/v1/organization-labels/api/v1/organization-labels/:key
Delete a label override (reverts to default)
Public
Response Example
{
"key": "nav.reports",
"deleted": true
}
POST
/api/v1/organization-labels/api/v1/organization-labels/initialize
Initialize labels for an organization — maps to initializeForOrganization(id)
Public
Request Example
{
"organization_id": "org-abc123"
}
Response Example
{
"organization_id": "org-abc123",
"labels_loaded": 24,
"initialized_at": "2026-03-26T10:00:00Z"
}
GET
/api/v1/organization-labels/api/v1/organization-labels/stream
Server-Sent Events stream for live label updates — maps to watchLabels()
Public
Response Example
{
"event": "labels_updated",
"data": {
"organization_id": "org-abc123",
"changed_keys": [
"app.title"
],
"labels": {
"app.title": "Acme Portal v2"
}
}
}