Skip to main content
Projects are workspace containers within an organization that group related content and assets. Each project maintains its own set of components, content types, content, and assets.

​
The Project Object

​
id
string
Unique identifier (UUID)
​
organizationId
string
Parent organization ID
​
name
string
Project name
​
slug
string
URL-friendly project identifier
​
description
string
Project description
​
status
string
Status: active, archived, or deleted
​
environment
string
Environment: production, staging, or development
​
settings
object
Project settings including locales, platforms, and CDN configuration
​
dependencies
object[]
Project dependencies with projectId and version
​
permissions
object
Project-level permissions and role configurations
​
metadata
object
Additional project metadata including createdBy and tags
​
createdAt
string
Creation timestamp (ISO 8601 format)
​
updatedAt
string
Last update timestamp (ISO 8601 format)

​
Settings Object

FieldTypeDescription
defaultLocalestringDefault content locale
supportedLocalesstring[]Available locales
defaultPlatformstringDefault platform for CMS preview (mobile, tablet, desktop)
supportedPlatformsstring[]Available platforms for content preview
thumbnailUrlstringProject thumbnail image URL for CMS display
cdnDomainstringCustom CDN domain

​
Example Object

{
  "id": "proj123",
  "organizationId": "org123",
  "name": "Marketing Website",
  "slug": "marketing-website",
  "description": "Main marketing website content",
  "status": "active",
  "environment": "production",
  "settings": {
    "defaultLocale": "en-US",
    "supportedLocales": ["en-US", "es-ES"],
    "defaultPlatform": "desktop",
    "supportedPlatforms": ["desktop", "mobile", "tablet"],
    "thumbnailUrl": "https://cdn.acme.com/thumbnails/marketing-website.png",
    "cdnDomain": "cdn.acme.com"
  },
  "dependencies": [
    {
      "projectId": "proj456",
      "version": "2.0.0"
    }
  ],
  "permissions": {
    "roles": {
      "admin": ["user123"],
      "editor": ["user456"]
    },
    "public": false
  },
  "metadata": {
    "createdBy": "user123",
    "tags": ["marketing", "website"]
  },
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z"
}

​
Project Structure

Projects contain the following resources:
  • Collections - Organizational groups for components
  • Components - View and layout components with versions
  • Content Types - Schemas defining content structure
  • Content - Actual content entries
  • Assets - Media files and images
  • Saved Searches - Reusable search configurations
  • Packages - Versioned snapshots of components

​
Project Dependencies

Projects can depend on other projects, allowing you to share components and content types across projects. Dependencies are specified with a project ID and semantic version. 
{
  "dependencies": [
    {
      "projectId": "proj456",
      "version": "2.0.0"
    }
  ]
}
When a package is created, it snapshots the current project dependencies, ensuring consistent behavior across deployments.