---
title: "Get a deployment"
method: GET
path: "/projects/{projectId}/deploys/{deploymentId}"
tags: ["Internal"]
---

# Get a deployment

`GET /projects/{projectId}/deploys/{deploymentId}`

## Request

- Base URL: `https://api.grapesjs.com/v1`
- URL: `https://api.grapesjs.com/v1/projects/{projectId}/deploys/{deploymentId}`
- Auth: HTTP bearer

Returns one deployment record and refreshes its current status. Use this endpoint to follow an individual publish attempt until it reaches a terminal state.

## Response `200`

Deployment fetched successfully

- DeploymentResponse
  - `deployment` Deployment, required
    - `id` string, required: Deployment record ID.
    - `deployTargetId` string, required
    - `providerId` 'default', required: Deploy provider identifier. Omit this field to use the default provider.
    - `status` 'queued' | 'building' | 'ready' | 'error' | 'canceled' | 'unknown', required
    - `url` string, nullable, required
    - `inspectorUrl` string, nullable, required
    - `error` string, nullable, required
    - `createdAt` string, date-time, required

## Other responses

- `400`: Invalid request
- `401`: Unauthorized
- `404`: Resource not found
- `500`: Server error

---

[API](https://skmtc.dev/grapesjs/apis/studio-platform-api.md) - [All operations](https://skmtc.dev/grapesjs/apis/studio-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/grapesjs/apis/studio-platform-api/revisions/acc4ffe35e2d?raw)