Projects Overview

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

string

Unique identifier (UUID)

string

Parent organization ID

string

Project name

string

URL-friendly project identifier

string

Project description

string

Status: active, archived, or deleted

string

Environment: production, staging, or development

object

Project settings including locales, platforms, and CDN configuration

object[]

Project dependencies with projectId and version

object

Project-level permissions and role configurations

object

Additional project metadata including createdBy and tags

string

Creation timestamp (ISO 8601 format)

string

Last update timestamp (ISO 8601 format)

Settings Object

Field	Type	Description
`defaultLocale`	string	Default content locale
`supportedLocales`	string[]	Available locales
`defaultPlatform`	string	Default platform for CMS preview (`mobile`, `tablet`, `desktop`)
`supportedPlatforms`	string[]	Available platforms for content preview
`thumbnailUrl`	string	Project thumbnail image URL for CMS display
`cdnDomain`	string	Custom 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.

Update Organization List Projects

Getting Started

API Basics

Organizations

Projects

Saved Searches

Folders

Components

Component Assets

Collections

Packages

Draft Packages

Content Types

Content

Assets

Asset Searching

Tags

Roles

API Keys

Projects Overview

The Project Object

Settings Object

Example Object

Project Structure

Project Dependencies

​The Project Object

​Settings Object

​Example Object

​Project Structure

​Project Dependencies

The Project Object

Settings Object

Example Object

Project Structure

Project Dependencies