🏠 Overview › 🔌 API Contracts ›🔌 Org Branding Cache

Org Branding Cache

API Contract

REST /api/v1/org-branding 6 endpoints
GET /api/v1/org-branding/api/v1/org-branding

List branding configurations for all organizations

Public

Response Example

{
  "data": [
    {
      "branding_id": "brd_01J4K8M2N3P5Q7B1",
      "org_id": "org_01J4K8M2N3P5Q7R9",
      "org_name": "Northbrook Academy",
      "logo_url": "https://cdn.eircodex.io/orgs/northbrook/logo.png",
      "primary_color": "#1A56DB",
      "updated_at": "2026-01-10T08:00:00Z"
    },
    {
      "branding_id": "brd_01J4K8M2N3P5Q7B2",
      "org_id": "org_01J4K8M2N3P5Q7R8",
      "org_name": "Westfield Learning Hub",
      "logo_url": "https://cdn.eircodex.io/orgs/westfield/logo.png",
      "primary_color": "#047857",
      "updated_at": "2026-02-05T08:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 47
  }
}
GET /api/v1/org-branding/api/v1/org-branding/:orgId

Get full branding configuration for a specific organization

Public

Response Example

{
  "branding_id": "brd_01J4K8M2N3P5Q7B1",
  "org_id": "org_01J4K8M2N3P5Q7R9",
  "org_name": "Northbrook Academy",
  "logo_url": "https://cdn.eircodex.io/orgs/northbrook/logo.png",
  "favicon_url": "https://cdn.eircodex.io/orgs/northbrook/favicon.ico",
  "color_tokens": {
    "primary": "#1A56DB",
    "primary_light": "#DBEAFE",
    "accent": "#7E3AF2",
    "background": "#F9FAFB",
    "surface": "#FFFFFF",
    "text_primary": "#111827",
    "text_secondary": "#6B7280"
  },
  "font_family": "Inter, sans-serif",
  "updated_at": "2026-01-10T08:00:00Z"
}
POST /api/v1/org-branding/api/v1/org-branding

Create branding configuration for an organization

Public

Request Example

{
  "org_id": "org_01J9X3P7K2M4N6Q8",
  "logo_url": "https://cdn.eircodex.io/orgs/riverdale/logo.png",
  "color_tokens": {
    "primary": "#DC2626",
    "accent": "#9333EA",
    "background": "#FEF2F2"
  },
  "font_family": "Poppins, sans-serif"
}

Response Example

{
  "branding_id": "brd_01J9X3P7K2M4N6H7",
  "org_id": "org_01J9X3P7K2M4N6Q8",
  "org_name": "Riverdale Tech Institute",
  "logo_url": "https://cdn.eircodex.io/orgs/riverdale/logo.png",
  "color_tokens": {
    "primary": "#DC2626",
    "accent": "#9333EA",
    "background": "#FEF2F2"
  },
  "font_family": "Poppins, sans-serif",
  "created_at": "2026-03-26T12:00:00Z"
}
PUT /api/v1/org-branding/api/v1/org-branding/:orgId

Update branding configuration for an organization

Public

Request Example

{
  "color_tokens": {
    "primary": "#1D4ED8",
    "accent": "#6D28D9"
  },
  "logo_url": "https://cdn.eircodex.io/orgs/northbrook/logo-v2.png"
}

Response Example

{
  "branding_id": "brd_01J4K8M2N3P5Q7B1",
  "org_id": "org_01J4K8M2N3P5Q7R9",
  "logo_url": "https://cdn.eircodex.io/orgs/northbrook/logo-v2.png",
  "color_tokens": {
    "primary": "#1D4ED8",
    "accent": "#6D28D9"
  },
  "updated_at": "2026-03-26T15:00:00Z"
}
DELETE /api/v1/org-branding/api/v1/org-branding/:orgId

Remove branding configuration and invalidate cache for an org

Public

Response Example

{
  "success": true,
  "cache_invalidated": true,
  "deleted_at": "2026-03-26T16:00:00Z"
}
POST /api/v1/org-branding/api/v1/org-branding/:orgId/preload

Preload and cache all branding assets for an organization

Public

Response Example

{
  "org_id": "org_01J4K8M2N3P5Q7R9",
  "assets_preloaded": 6,
  "cache_ttl_seconds": 3600,
  "preloaded_at": "2026-03-26T12:00:00Z"
}

Additional Metadata

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