Get design item

GET/v1/design/items/{id}

Signed-in sessionLaunch key product.designOperation design_item_get

An internal tool for the components agents build and the rules they follow.

Path parameters

idstringRequired

Query parameters

expectedAuthorizationVersionstring

Returns

idstringRequired
folderIdnull | stringRequired
kind"block" | "component" | "link" | "note" | "screenshot"Required
titlestringRequired
bodynull | stringRequired
urlnull | stringRequired
visibility"private" | "tenant"Required
createdAtnumberRequired
updatedAtnumberRequired
versionnull | numberRequired
authorobjectRequired
componentnull | objectRequired
imagenull | objectRequired
schemaVersion1Required

Errors

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

GET/v1/design/items/{id}

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

Response

{
  "result": {
    "id": "<id>",
    "folderId": "<folderId>",
    "kind": "block",
    "title": "<title>",
    "body": "<body>",
    "url": "<url>",
    "visibility": "private",
    "createdAt": 1,
    "updatedAt": 1,
    "version": "<version>",
    "author": {
      "name": "<name>",
      "agent": true
    },
    "component": "<component>",
    "image": "<image>",
    "schemaVersion": 1
  }
}