Projects

Get a project

Get a project by ID or slug. Use expand to include the project brief (assumptions).

get/projects/{projectId}

Request

Base URL: https://next-api.saturation.io/v1
URL: https://next-api.saturation.io/v1/projects/{projectId}
Auth: HTTP bearer

Query parameters

expandProjectExpand[]

Comma list of related data to inline on projects (depth ≤ 2). Unknown key returns 400 expand_invalid.

Response

The project.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

slugstring required

The project's human handle, unique per workspace.

namestring required

Display name.

emojistring nullable

Emoji shown with the project.

imagestring nullable

Cover image URL.

status'active' | 'archived' required

Project status.

summarystring nullable

A short project summary.

spaceIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

projectTypestring nullable

Production format, such as Feature film or Commercial.

createdAtstring date-time required

ISO 8601 creation time.

updatedAtstring date-time required

ISO 8601 last update time.

Example response

{
  "id": "txn_8f2a1c9e",
  "slug": "q3-feature-doc",
  "name": "Q3 Feature Doc",
  "spaceId": "txn_8f2a1c9e",
  "tags": [
    {
      "id": "txn_8f2a1c9e"
    }
  ],
  "createdBy": {
    "id": "txn_8f2a1c9e"
  },
  "assumptions": {
    "noteId": "txn_8f2a1c9e"
  }
}

Changes

Changes to this operation have not been checked yet.