---
title: "Creating a Project Snapshot"
method: POST
path: "/project_snapshots"
tags: ["Project Snapshots"]
---

# Creating a Project Snapshot

`POST /project_snapshots`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/project_snapshots`
- Auth: none declared

Creates a Project Snapshot. You must have the Edit Financials project permission or higher to create a project snapshot. 

This endpoint has its own rate limit. See the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/9698066628123) for more information.


This endpoint returns structured Project Snapshots objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `project_snapshots` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `include` string

## Request body

- object
  - `project_snapshot` object
    - `workspace_id` integer, required: The ID of the workspace to take a snapshot of.
    - `title` string: The title of the snapshot.
    - `description` string: The description of the snapshot.
    - `replace_baseline` boolean: Whether the snapshot should be set as the workspace's baseline.

## Response `200`

Project Snapshots has been created.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `project_snapshots` object
  - `project_snapshot_resources` object
  - `project_snapshot_tasks` object
  - `project_snapshot_custom_field_values` object
  - `project_snapshot_assignments` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)