v1

latestOpenAPI 3.0.02026-07-267316.2 KB
Project

Retrieve information about a project (scope: data.read)

get/workspace/{workspace-id}/project/{project-id}

Path parameters

workspace-idstring required

The identifier for the workspace

project-idstring required

The identifier for the project in the workspace

Response

The project information was retrieved successfully

workspacestring required

The workspace id (matches the workspace-id sent with the request)

projectstring required

The project id (matches the project-id sent with the request)

namestring required

The name assigned to the project

urlstring

The url where the published project can be viewed

status'Draft' | 'Changed' | 'UpToDate' | 'Processing' required

The published state of the project.

  • Draft: The project has not yet been published (or was unpublished)
  • Changed: The project is published but there are unpublished changes
  • Published: The project is published with no unpublished changes
  • Processing: The project is in the process of being copied
createdAtstring date-time required

The date and time when the project was created (ISO8601 format)

updatedAtstring date-time required

The date and time when the project was last updated (ISO8601 format)

publishedAtstring date-time

The date and time when the project was last published (ISO8601 format)

Example response

{
  "workspace": "z3plqkvf52r",
  "project": "3e95a13e7f1",
  "name": "Standards",
  "url": "https://brand.standards.site",
  "status": "Changed",
  "createdAt": "2026-02-11T18:25:43.000Z",
  "updatedAt": "2026-03-10T12:14:57.000Z",
  "publishedAt": "2026-03-08T03:40:29.000Z"
}