Get design project

GET/v1/design/projects/{id}

Signed-in sessionLaunch key product.designOperation design_project_get

An internal tool for design rules and components that agents synthesize, review and promote, with evaluation runs to check them.

Path parameters

idstringRequired

Query parameters

expectedAuthorizationVersionstring

Returns

idstringRequired
keystringRequired
namestringRequired
visibility"private" | "tenant"Required
repoRefobjectRequired
designSystemRefstringRequired
status"active" | "archived"Required
versionnumberRequired
createdAtnumberRequired
updatedAtnumberRequired
schemaVersion1Required

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

GET/v1/design/projects/{id}

curl "$SPECIFY_API_ORIGIN/v1/design/projects/<id>" \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

Response

{
  "result": {
    "id": "<id>",
    "key": "<key>",
    "name": "<name>",
    "visibility": "private",
    "repoRef": {
      "ref": "<ref>",
      "repository": "<repository>"
    },
    "designSystemRef": "<designSystemRef>",
    "status": "active",
    "version": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "schemaVersion": 1
  }
}